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