CR-653 Fix for OPENDJ-584: base64 tool reference does not show subcommand o...

Mark Craig

10.50.2012 a529794c540a35a2d669390de32ea792e1db1f19

CR-653 Fix for OPENDJ-584: base64 tool reference does not show subcommand options

 opendj3/src/main/docbkx/shared/man-base64.xml

@@ -42,8 +42,7 @@
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>base64</command>
   <command><replaceable>subcommand</replaceable></command>
   <command>base64 <replaceable>subcommand</replaceable></command>
   <arg choice="req">options</arg>
  </cmdsynopsis>
 </refsynopsisdiv>
@@ -59,12 +58,62 @@
    <term><command>base64 decode</command></term>
    <listitem>
     <para>Decode base64-encoded information into raw data</para>
     <para>When no options are specified, this subcommand reads from standard
     input and writes to standard output.</para>
     <variablelist>
      <title>Decode Options</title>
      <varlistentry>
       <term><option>-d, --encodedData {data}</option></term>
       <listitem>
        <para>The base64-encoded data to be decoded</para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><option>-f, --encodedDataFile {path}</option></term>
       <listitem>
        <para>The path to a file containing the base64-encoded data to be
        decoded</para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><option>-o, --toRawFile {path}</option></term>
       <listitem>
        <para>The path to a file to which the raw base64-decoded data should be
        written</para>
       </listitem>
      </varlistentry>
     </variablelist>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><command>base64 encode</command></term>
    <listitem>
     <para>Encode raw data using base64</para>
     <para>When no options are specified, this subcommand reads from standard
     input and writes to standard output.</para>
     <variablelist>
      <title>Decode Options</title>
      <varlistentry>
       <term><option>-d, --rawData {data}</option></term>
       <listitem>
        <para>The raw data to be base64 encoded</para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><option>-f, --rawDataFile {path}</option></term>
       <listitem>
        <para>The path to a file containing the raw data to be base64
        encoded</para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><option>-o, --toEncodedFile {path}</option></term>
       <listitem>
        <para>The path to a file to which the base64-encoded data should be
        written</para>
       </listitem>
      </varlistentry>
     </variablelist>
    </listitem>
   </varlistentry>
  </variablelist>

 opends/resource/man/man1/base64.1

@@ -2,12 +2,12 @@
.\"     Title: base64
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 03/21/2012
.\"      Date: 09/04/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "BASE64" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "BASE64" "1" "09/04/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -30,8 +30,8 @@
.SH "NAME"
base64 \- encode and decode base64 strings
.SH "SYNOPSIS"
.HP \w'\fBbase64\fR\fB\fIsubcommand\fR\fR\ 'u
\fBbase64\fR\fB\fIsubcommand\fR\fR {options}
.HP \w'\fBbase64\ \fR\fB\fIsubcommand\fR\fR\ 'u
\fBbase64 \fR\fB\fIsubcommand\fR\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to encode and decode information using base64\&.
@@ -42,11 +42,45 @@
\fBbase64 decode\fR
.RS 4
Decode base64\-encoded information into raw data
.sp
When no options are specified, this subcommand reads from standard input and writes to standard output\&.
.PP
\fB\-d, \-\-encodedData {data}\fR
.RS 4
The base64\-encoded data to be decoded
.RE
.PP
\fB\-f, \-\-encodedDataFile {path}\fR
.RS 4
The path to a file containing the base64\-encoded data to be decoded
.RE
.PP
\fB\-o, \-\-toRawFile {path}\fR
.RS 4
The path to a file to which the raw base64\-decoded data should be written
.RE
.RE
.PP
\fBbase64 encode\fR
.RS 4
Encode raw data using base64
.sp
When no options are specified, this subcommand reads from standard input and writes to standard output\&.
.PP
\fB\-d, \-\-rawData {data}\fR
.RS 4
The raw data to be base64 encoded
.RE
.PP
\fB\-f, \-\-rawDataFile {path}\fR
.RS 4
The path to a file containing the raw data to be base64 encoded
.RE
.PP
\fB\-o, \-\-toEncodedFile {path}\fR
.RS 4
The path to a file to which the base64\-encoded data should be written
.RE
.RE
.SH "GENERAL OPTIONS"
.PP