docs: add vfs_ceph_snapshots manpage
[samba.git] / docs-xml / wscript_build
1 #!/usr/bin/env python
2 from samba_utils import save_file
3 import os
4 manpages='''
5          manpages/cifsdd.8
6          manpages/dbwrap_tool.1
7          manpages/eventlogadm.8
8          manpages/findsmb.1
9          manpages/idmap_ad.8
10          manpages/idmap_autorid.8
11          manpages/idmap_hash.8
12          manpages/idmap_ldap.8
13          manpages/idmap_nss.8
14          manpages/idmap_rfc2307.8
15          manpages/idmap_rid.8
16          manpages/idmap_script.8
17          manpages/idmap_tdb.8
18          manpages/idmap_tdb2.8
19          manpages/libsmbclient.7
20          manpages/lmhosts.5
21          manpages/log2pcap.1
22          manpages/mvxattr.1
23          manpages/net.8
24          manpages/nmbd.8
25          manpages/nmblookup.1
26          manpages/ntlm_auth.1
27          manpages/pdbedit.8
28          manpages/profiles.1
29          manpages/rpcclient.1
30          manpages/samba-regedit.8
31          manpages/samba-tool.8
32          manpages/samba.7
33          manpages/samba.8
34          manpages/sharesec.1
35          manpages/smbcacls.1
36          manpages/smbclient.1
37          manpages/smbcontrol.1
38          manpages/smbcquotas.1
39          manpages/smbd.8
40          manpages/smbget.1
41          manpages/smbgetrc.5
42          manpages/smbpasswd.5
43          manpages/smbpasswd.8
44          manpages/smbspool_krb5_wrapper.8
45          manpages/smbspool.8
46          manpages/smbstatus.1
47          manpages/smbtar.1
48          manpages/smbtree.1
49          manpages/testparm.1
50          manpages/traffic_learner.7
51          manpages/traffic_replay.7
52          manpages/vfstest.1
53          manpages/wbinfo.1
54          manpages/winbindd.8
55          '''
56
57 pam_winbind_manpages = '''
58                        manpages/pam_winbind.8
59                        manpages/pam_winbind.conf.5
60                        '''
61
62 krb5_locator_manpages = 'manpages/winbind_krb5_locator.8'
63 krb5_localauth_manpages = 'manpages/winbind_krb5_localauth.8'
64
65 vfs_module_manpages = ['vfs_acl_tdb',
66                        'vfs_acl_xattr',
67                        'vfs_aio_fork',
68                        'vfs_aio_pthread',
69                        'vfs_audit',
70                        'vfs_btrfs',
71                        'vfs_cacheprime',
72                        'vfs_cap',
73                        'vfs_catia',
74                        'vfs_ceph',
75                        'vfs_ceph_snapshots',
76                        'vfs_commit',
77                        'vfs_crossrename',
78                        'vfs_default_quota',
79                        'vfs_dirsort',
80                        'vfs_extd_audit',
81                        'vfs_fake_perms',
82                        'vfs_fileid',
83                        'vfs_fruit',
84                        'vfs_full_audit',
85                        'vfs_glusterfs',
86                        'vfs_glusterfs_fuse',
87                        'vfs_gpfs',
88                        'vfs_linux_xfs_sgid',
89                        'vfs_media_harmony',
90                        'vfs_netatalk',
91                        'vfs_nfs4acl_xattr',
92                        'vfs_offline',
93                        'vfs_prealloc',
94                        'vfs_preopen',
95                        'vfs_readahead',
96                        'vfs_readonly',
97                        'vfs_recycle',
98                        'vfs_shadow_copy',
99                        'vfs_shadow_copy2',
100                        'vfs_shell_snap',
101                        'vfs_snapper',
102                        'vfs_streams_depot',
103                        'vfs_streams_xattr',
104                        'vfs_syncops',
105                        'vfs_time_audit',
106                        'vfs_tsmsm',
107                        'vfs_unityed_media',
108                        'vfs_virusfilter',
109                        'vfs_worm',
110                        'vfs_xattr_tdb',
111                        'vfs_zfsacl' ]
112
113 def smbdotconf_generate_parameter_list(task):
114     parameter_all = task.outputs[0].bldpath(task.env)
115     articles = task.inputs
116
117     entities = bld.pathconfig_entities()
118     t = "<!DOCTYPE section [\n"
119
120     for entity in entities:
121         t += "%s\n" % entity
122
123     # We need this if we build with Heimdal
124     mit_kdc_path = '"/usr/sbin/krb5kdc"'
125
126     # The MIT krb5kdc path is set if we build with MIT Kerberos
127     if bld.CONFIG_SET('MIT_KDC_PATH'):
128         mit_kdc_path = bld.CONFIG_GET('MIT_KDC_PATH')
129
130     t += "<!ENTITY pathconfig.MITKDCPATH   %s>\n" % mit_kdc_path
131
132     t += "]>\n"
133     t += "<section>\n"
134     for article in articles:
135         t += article.read()
136
137     t += "</section>\n"
138     save_file(parameter_all, t , create_dir=True)
139     return 0
140
141 # Since nothing really forces sorting in glob, we have to sort by file name
142 # POSIX file systems aren't required to return sorted content but we want
143 # smb.conf parameters to be sorted alphabetically
144 parameter_all = 'smbdotconf/parameters.all.xml'
145 sources = bld.path.ant_glob("smbdotconf/**/*.xml", flat=False, excl=parameter_all)
146 articles = " ".join(sorted([x.path_from(bld.path) for x in sources],
147                            key=lambda m: m.split(os.sep)[-1]))
148
149 bld.SAMBA_GENERATOR(parameter_all,
150                     source=articles,
151                     target=parameter_all,
152                     rule=smbdotconf_generate_parameter_list,
153                     dep_vars=bld.dynconfig_varnames())
154
155 def SMBDOTCONF_MANPAGE(bld, target):
156     ''' assemble and build smb.conf.5 manual page'''
157     bld.SAMBAMANPAGES(target, parameter_all)
158
159 if ('XSLTPROC_MANPAGES' in bld.env and bld.env['XSLTPROC_MANPAGES']):
160
161     SMBDOTCONF_MANPAGE(bld, 'manpages/smb.conf.5')
162     bld.SAMBAMANPAGES(manpages)
163
164     if bld.CONFIG_SET('WITH_PAM_MODULES') and bld.CONFIG_SET('HAVE_PAM_START'):
165         bld.SAMBAMANPAGES(pam_winbind_manpages)
166
167     if bld.CONFIG_SET('HAVE_KRB5_LOCATE_PLUGIN_H'):
168         bld.SAMBAMANPAGES(krb5_locator_manpages)
169
170     if bld.CONFIG_SET('HAVE_KRB5_LOCALAUTH_PLUGIN_H'):
171         bld.SAMBAMANPAGES(krb5_localauth_manpages)
172
173     for manpage in vfs_module_manpages:
174         if bld.SAMBA3_IS_ENABLED_MODULE(manpage):
175             bld.SAMBAMANPAGES('manpages/%s.8' % manpage)