man-base64.xml revision 7321
7321N/A<?xml version="1.0" encoding="UTF-8"?>
7321N/A<!--
7321N/A ! CCPL HEADER START
7321N/A !
7321N/A ! This work is licensed under the Creative Commons
7321N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
7321N/A ! To view a copy of this license, visit
7321N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
7321N/A ! or send a letter to Creative Commons, 444 Castro Street,
7321N/A ! Suite 900, Mountain View, California, 94041, USA.
7321N/A !
7321N/A ! You can also obtain a copy of the license at
7321N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
7321N/A ! See the License for the specific language governing permissions
7321N/A ! and limitations under the License.
7321N/A !
7321N/A ! If applicable, add the following below this CCPL HEADER, with the fields
7321N/A ! enclosed by brackets "[]" replaced with your own identifying information:
7321N/A ! Portions Copyright [yyyy] [name of copyright owner]
7321N/A !
7321N/A ! CCPL HEADER END
7321N/A !
7321N/A ! Copyright 2011-2014 ForgeRock AS
7321N/A !
7321N/A-->
7321N/A<refentry xml:id='base64-1'
7321N/A xmlns='http://docbook.org/ns/docbook'
7321N/A version='5.0' xml:lang='en'
7321N/A xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
7321N/A xsi:schemaLocation='http://docbook.org/ns/docbook
7321N/A http://docbook.org/xml/5.0/xsd/docbook.xsd'>
7321N/A <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
7321N/A <refmeta>
7321N/A <refentrytitle>base64</refentrytitle><manvolnum>1</manvolnum>
7321N/A <refmiscinfo class="software">OpenDJ</refmiscinfo>
7321N/A <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
7321N/A </refmeta>
7321N/A <refnamediv>
7321N/A <refname>base64</refname>
7321N/A <refpurpose>encode and decode base64 strings</refpurpose>
7321N/A </refnamediv>
7321N/A <refsynopsisdiv>
7321N/A <cmdsynopsis>
7321N/A <command>base64 <replaceable>subcommand</replaceable></command>
7321N/A <arg choice="req">options</arg>
7321N/A </cmdsynopsis>
7321N/A </refsynopsisdiv>
7321N/A <refsect1>
7321N/A <title>Description</title>
7321N/A <para>This utility can be used to encode and decode information using base64.</para>
7321N/A </refsect1>
7321N/A <refsect1>
7321N/A <title>Subcommands</title>
7321N/A <para>The following subcommands are supported.</para>
7321N/A <variablelist>
7321N/A <varlistentry>
7321N/A <term><command>base64 decode</command></term>
7321N/A <listitem>
7321N/A <para>Decode base64-encoded information into raw data</para>
7321N/A <para>When no options are specified, this subcommand reads from standard
7321N/A input and writes to standard output.</para>
7321N/A <variablelist>
7321N/A <title>Decode Options</title>
7321N/A <varlistentry>
7321N/A <term><option>-d, --encodedData {data}</option></term>
7321N/A <listitem>
7321N/A <para>The base64-encoded data to be decoded</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-f, --encodedDataFile {path}</option></term>
7321N/A <listitem>
7321N/A <para>The path to a file containing the base64-encoded data to be
7321N/A decoded</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-o, --toRawFile {path}</option></term>
7321N/A <listitem>
7321N/A <para>The path to a file to which the raw base64-decoded data should be
7321N/A written</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A </variablelist>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><command>base64 encode</command></term>
7321N/A <listitem>
7321N/A <para>Encode raw data using base64</para>
7321N/A <para>When no options are specified, this subcommand reads from standard
7321N/A input and writes to standard output.</para>
7321N/A <variablelist>
7321N/A <title>Decode Options</title>
7321N/A <varlistentry>
7321N/A <term><option>-d, --rawData {data}</option></term>
7321N/A <listitem>
7321N/A <para>The raw data to be base64 encoded</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-f, --rawDataFile {path}</option></term>
7321N/A <listitem>
7321N/A <para>The path to a file containing the raw data to be base64
7321N/A encoded</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-o, --toEncodedFile {path}</option></term>
7321N/A <listitem>
7321N/A <para>The path to a file to which the base64-encoded data should be
7321N/A written</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A </variablelist>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A </variablelist>
7321N/A </refsect1>
7321N/A <refsect1>
7321N/A <title>General Options</title>
7321N/A <variablelist>
7321N/A <varlistentry>
7321N/A <term><option>-V, --version</option></term>
7321N/A <listitem>
7321N/A <para>Display version information</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-?, -H, --help</option></term>
7321N/A <listitem>
7321N/A <para>Display usage information</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A </variablelist>
7321N/A </refsect1>
7321N/A <refsect1>
7321N/A <title>Exit Codes</title>
7321N/A <variablelist>
7321N/A <varlistentry>
7321N/A <term>0</term>
7321N/A <listitem>
7321N/A <para>The command completed successfully.</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term>&gt; 0</term>
7321N/A <listitem>
7321N/A <para>An error occurred.</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A </variablelist>
7321N/A </refsect1>
7321N/A <refsect1>
7321N/A <title>Examples</title>
7321N/A <para>The following command shows the changes from the external change log
7321N/A in human-readable format.</para>
7321N/A
7321N/A <screen>
7321N/A$ <userinput>base64 decode -d YWRkOiBkZXNjcmlwdGlvbgpkZXNjcmlwdGlvbjogQSB0aGlyZCBjaGFuZ2UK\
7321N/ALQpyZXBsYWNlOiBtb2RpZmllcnNOYW1lCm1vZGlmaWVyc05hbWU6IGNuPURpcmVjdG9yeSBNYW5hZ2V\
7321N/AyLGNuPVJvb3QgRE5zLGNuPWNvbmZpZwotCnJlcGxhY2U6IG1vZGlmeVRpbWVzdGFtcAptb2RpZnlUaW\
7321N/A1lc3RhbXA6IDIwMTEwNjEzMDcxMjEwWgotCg==</userinput>
7321N/A<computeroutput>add: description
7321N/Adescription: A third change
7321N/A-
7321N/Areplace: modifiersName
7321N/AmodifiersName: cn=Directory Manager,cn=Root DNs,cn=config
7321N/A-
7321N/Areplace: modifyTimestamp
7321N/AmodifyTimestamp: 20110613071210Z
7321N/A-</computeroutput>
7321N/A </screen>
7321N/A </refsect1>
7321N/A</refentry>