From 74f196dfa23f8d68c94142488fda18f75df90542 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Mon, 10 Sep 2012 07:50:31 +0000
Subject: [PATCH] CR-653 Fix for OPENDJ-584: base64 tool reference does not show subcommand options
---
opendj-sdk/opends/resource/man/man1/base64.1 | 42 +++++++++++++++++++--
opendj-sdk/opendj3/src/main/docbkx/shared/man-base64.xml | 53 +++++++++++++++++++++++++-
2 files changed, 89 insertions(+), 6 deletions(-)
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/man-base64.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/man-base64.xml
index b9e9910..9a41164 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/shared/man-base64.xml
+++ b/opendj-sdk/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>
diff --git a/opendj-sdk/opends/resource/man/man1/base64.1 b/opendj-sdk/opends/resource/man/man1/base64.1
index ab8b52d..cb1aaca 100644
--- a/opendj-sdk/opends/resource/man/man1/base64.1
+++ b/opendj-sdk/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
--
Gitblit v1.10.0