mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Jean-Noël Rouvignac
28.33.2016 6afc3f0ae019111a1f50bb39ba2cc0b1cfd0e70c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
<?xml version="1.0" encoding="UTF-8"?>
<!--
  The contents of this file are subject to the terms of the Common Development and
  Distribution License (the License). You may not use this file except in compliance with the
  License.
 
  You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
  specific language governing permission and limitations under the License.
 
  When distributing Covered Software, include this CDDL Header Notice in each file and include
  the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
  Header, with the fields enclosed by brackets [] replaced by your own identifying
  information: "Portions Copyright [year] [name of copyright owner]".
 
  Copyright 2015-2016 ForgeRock AS.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
 
    <parent>
        <groupId>org.forgerock.opendj</groupId>
        <artifactId>opendj-parent</artifactId>
        <version>4.0.0-SNAPSHOT</version>
    </parent>
 
    <artifactId>opendj-man-pages</artifactId>
    <name>OpenDJ Man Pages</name>
    <description>This module contains OpenDJ tools man pages.</description>
 
    <packaging>pom</packaging>
 
    <dependencies>
        <dependency>
            <groupId>org.forgerock.opendj</groupId>
            <artifactId>opendj-server-legacy</artifactId>
            <version>${project.version}</version>
        </dependency>
    </dependencies>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.forgerock.opendj</groupId>
                <artifactId>opendj-doc-maven-plugin</artifactId>
                <version>${project.version}</version>
                <executions>
                    <execution>
                        <id>generate-man-pages</id>
                        <goals>
                            <goal>generate-refentry</goal>
                        </goals>
                        <phase>process-classes</phase>
                        <configuration>
                            <outputDir>${project.build.directory}/docbkx-sources/man-pages</outputDir>
                            <tools>
                                <tool>
                                    <name>backendstat</name>
                                    <application>org.opends.server.backends.pluggable.BackendStat</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>backendstat-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>backup</name>
                                    <application>org.opends.server.tools.BackUpDB</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-1.xml</trailingSectionPath>
                                        <trailingSectionPath>backup-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>base64</name>
                                    <application>org.opends.server.util.Base64</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>base64-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>control-panel</name>
                                    <application>org.opends.guitools.controlpanel.ControlPanelLauncher</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>control-panel-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>create-rc-script</name>
                                    <application>org.opends.server.tools.CreateRCScript</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>create-rc-script-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>dsconfig</name>
                                    <application>org.forgerock.opendj.config.dsconfig.DSConfig</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>dsconfig-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>dsjavaproperties</name>
                                    <application>org.opends.server.tools.JavaPropertiesTool</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>dsjavaproperties-files.xml</trailingSectionPath>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>dsjavaproperties-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>dsreplication</name>
                                    <application>org.opends.server.tools.dsreplication.ReplicationCliMain</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>dsreplication-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>encode-password</name>
                                    <application>org.opends.server.tools.EncodePassword</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-5-6-other.xml</trailingSectionPath>
                                        <trailingSectionPath>encode-password-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>export-ldif</name>
                                    <application>org.opends.server.tools.ExportLDIF</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>export-ldif-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>import-ldif</name>
                                    <application>org.opends.server.tools.ImportLDIF</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>export-ldif-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>ldapcompare</name>
                                    <application>org.opends.server.tools.LDAPCompare</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>ldapcompare-exit-codes.xml</trailingSectionPath>
                                        <trailingSectionPath>files.xml</trailingSectionPath>
                                        <trailingSectionPath>ldapcompare-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>ldapdelete</name>
                                    <application>org.opends.server.tools.LDAPDelete</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                                        <trailingSectionPath>files.xml</trailingSectionPath>
                                        <trailingSectionPath>ldapdelete-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>ldapmodify</name>
                                    <application>org.opends.server.tools.LDAPModify</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                                        <trailingSectionPath>files.xml</trailingSectionPath>
                                        <trailingSectionPath>ldapmodify-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>ldappasswordmodify</name>
                                    <application>org.opends.server.tools.LDAPPasswordModify</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                                        <trailingSectionPath>files.xml</trailingSectionPath>
                                        <trailingSectionPath>ldappasswordmodify-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>ldapsearch</name>
                                    <application>org.opends.server.tools.LDAPSearch</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>filters.xml</trailingSectionPath>
                                        <trailingSectionPath>attributes.xml</trailingSectionPath>
                                        <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                                        <trailingSectionPath>files.xml</trailingSectionPath>
                                        <trailingSectionPath>ldapsearch-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>ldif-diff</name>
                                    <application>org.opends.server.tools.LDIFDiff</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-5-6-other.xml</trailingSectionPath>
                                        <trailingSectionPath>ldif-diff-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>ldifmodify</name>
                                    <application>org.opends.server.tools.LDIFModify</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>ldifmodify-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>ldifsearch</name>
                                    <application>org.opends.server.tools.LDIFSearch</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>ldifsearch-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>list-backends</name>
                                    <application>org.opends.server.tools.ListBackends</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>list-backends-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>make-ldif</name>
                                    <application>org.opends.server.tools.makeldif.MakeLDIF</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>make-ldif-examples.xml</trailingSectionPath>
                                        <trailingSectionPath>make-ldif-see-also.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>manage-account</name>
                                    <application>org.opends.server.tools.ManageAccount</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-89.xml</trailingSectionPath>
                                        <trailingSectionPath>manage-account-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>manage-tasks</name>
                                    <application>org.opends.server.tools.ManageTasks</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>manage-tasks-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>rebuild-index</name>
                                    <application>org.opends.server.tools.RebuildIndex</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>rebuild-index-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>restore</name>
                                    <application>org.opends.server.tools.RestoreDB</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>restore-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>setup</name>
                                    <application>org.opends.quicksetup.installer.SetupLauncher</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>setup-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>start-ds</name>
                                    <application>org.opends.server.core.DirectoryServer</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>start-ds-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>status</name>
                                    <application>org.opends.server.tools.status.StatusCli</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>status-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>stop-ds</name>
                                    <application>org.opends.server.tools.StopDS</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>stop-ds-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>uninstall</name>
                                    <application>org.opends.guitools.uninstaller.UninstallLauncher</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                                        <trailingSectionPath>uninstall-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>upgrade</name>
                                    <application>org.opends.server.tools.upgrade.UpgradeCli</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>upgrade-exit-codes.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
 
                                <tool>
                                    <name>verify-index</name>
                                    <application>org.opends.server.tools.VerifyIndex</application>
                                    <trailingSectionPaths>
                                        <trailingSectionPath>verify-index-exit-codes.xml</trailingSectionPath>
                                        <trailingSectionPath>verify-index-examples.xml</trailingSectionPath>
                                    </trailingSectionPaths>
                                </tool>
                            </tools>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
 
            <!-- Format man pages -->
            <plugin>
                <groupId>org.forgerock.commons</groupId>
                <artifactId>forgerock-doc-maven-plugin</artifactId>
                <version>${forgerock-doc-plugin.version}</version>
                <configuration>
                    <projectName>OpenDJ</projectName>
                    <projectVersion>${project.version}</projectVersion>
                    <releaseVersion>${project.version}</releaseVersion>
                    <googleAnalyticsId>UA-23412190-8</googleAnalyticsId>
                    <formats combine.self="override">
                        <format>man</format>
                    </formats>
                </configuration>
                <executions>
                    <execution>
                        <id>build-man-pages</id>
                        <phase>package</phase>
                        <goals>
                            <goal>process</goal>
                            <goal>build</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
 
            <!-- Generate Artefacts -->
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <executions>
                    <execution>
                        <id>man-pages-sources</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <descriptors>
                                <descriptor>src/main/assembly/man-page-sources-assembly.xml</descriptor>
                            </descriptors>
                        </configuration>
                    </execution>
 
                    <execution>
                        <id>man-pages</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <descriptors>
                                <descriptor>src/main/assembly/man-pages-assembly.xml</descriptor>
                            </descriptors>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>