docs-xml:samba-tool.8: document "group move" command
[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/vfs_acl_tdb.8
53          manpages/vfs_acl_xattr.8
54          manpages/vfs_aio_fork.8
55          manpages/vfs_aio_pthread.8
56          manpages/vfs_audit.8
57          manpages/vfs_btrfs.8
58          manpages/vfs_cacheprime.8
59          manpages/vfs_cap.8
60          manpages/vfs_catia.8
61          manpages/vfs_ceph.8
62          manpages/vfs_commit.8
63          manpages/vfs_crossrename.8
64          manpages/vfs_default_quota.8
65          manpages/vfs_dirsort.8
66          manpages/vfs_extd_audit.8
67          manpages/vfs_fake_perms.8
68          manpages/vfs_fileid.8
69          manpages/vfs_fruit.8
70          manpages/vfs_full_audit.8
71          manpages/vfs_glusterfs.8
72          manpages/vfs_gpfs.8
73          manpages/vfs_linux_xfs_sgid.8
74          manpages/vfs_media_harmony.8
75          manpages/vfs_netatalk.8
76          manpages/vfs_nfs4acl_xattr.8
77          manpages/vfs_offline.8
78          manpages/vfs_prealloc.8
79          manpages/vfs_preopen.8
80          manpages/vfs_readahead.8
81          manpages/vfs_readonly.8
82          manpages/vfs_recycle.8
83          manpages/vfs_shadow_copy.8
84          manpages/vfs_shadow_copy2.8
85          manpages/vfs_shell_snap.8
86          manpages/vfs_snapper.8
87          manpages/vfs_streams_depot.8
88          manpages/vfs_streams_xattr.8
89          manpages/vfs_syncops.8
90          manpages/vfs_time_audit.8
91          manpages/vfs_tsmsm.8
92          manpages/vfs_unityed_media.8
93          manpages/vfs_virusfilter.8
94          manpages/vfs_worm.8
95          manpages/vfs_xattr_tdb.8
96          manpages/vfstest.1
97          manpages/wbinfo.1
98          manpages/winbindd.8
99          '''
100
101 pam_winbind_manpages = '''
102                        manpages/pam_winbind.8
103                        manpages/pam_winbind.conf.5
104                        '''
105
106 krb5_locator_manpages = 'manpages/winbind_krb5_locator.7'
107
108 def smbdotconf_generate_parameter_list(task):
109     parameter_all = task.outputs[0].bldpath(task.env)
110     articles = task.inputs
111
112     entities = bld.pathconfig_entities()
113     t = "<!DOCTYPE section [\n"
114
115     for entity in entities:
116         t += "%s\n" % entity
117
118     # We need this if we build with Heimdal
119     mit_kdc_path = '"/usr/sbin/krb5kdc"'
120
121     # The MIT krb5kdc path is set if we build with MIT Kerberos
122     if bld.CONFIG_SET('MIT_KDC_PATH'):
123         mit_kdc_path = bld.CONFIG_GET('MIT_KDC_PATH')
124
125     t += "<!ENTITY pathconfig.MITKDCPATH   %s>\n" % mit_kdc_path
126
127     t += "]>\n"
128     t += "<section>\n"
129     for article in articles:
130         t += article.read()
131
132     t += "</section>\n"
133     save_file(parameter_all, t , create_dir=True)
134     return 0
135
136 # Since nothing really forces sorting in glob, we have to sort by file name
137 # POSIX file systems aren't required to return sorted content but we want
138 # smb.conf parameters to be sorted alphabetically
139 sources = bld.path.ant_glob("smbdotconf/**/*.xml", flat=False)
140 articles = " ".join(sorted([x.relpath_gen(bld.path) for x in sources],
141                            key=lambda m: m.split(os.sep)[-1]))
142
143 parameter_all = 'smbdotconf/parameters.all.xml'
144 bld.SAMBA_GENERATOR(parameter_all,
145                     source=articles,
146                     target=parameter_all,
147                     rule=smbdotconf_generate_parameter_list,
148                     dep_vars=bld.dynconfig_varnames())
149
150 def SMBDOTCONF_MANPAGE(bld, target):
151     ''' assemble and build smb.conf.5 manual page'''
152     bld.SAMBAMANPAGES(target, parameter_all)
153
154 if ('XSLTPROC_MANPAGES' in bld.env and bld.env['XSLTPROC_MANPAGES']):
155
156     SMBDOTCONF_MANPAGE(bld, 'manpages/smb.conf.5')
157     bld.SAMBAMANPAGES(manpages)
158
159     if bld.CONFIG_SET('WITH_PAM_MODULES') and bld.CONFIG_SET('HAVE_PAM_START'):
160         bld.SAMBAMANPAGES(pam_winbind_manpages)
161
162     if bld.CONFIG_SET('HAVE_KRB5_LOCATE_PLUGIN_H'):
163         bld.SAMBAMANPAGES(krb5_locator_manpages)
164
165     if bld.SAMBA3_IS_ENABLED_MODULE('vfs_zfsacl'):
166         bld.SAMBAMANPAGES('manpages/vfs_zfsacl.8')