6330N/A<?xml version="1.0" encoding="UTF-8"?>
6330N/A<!--
6330N/A ! CCPL HEADER START
6330N/A !
6330N/A ! This work is licensed under the Creative Commons
6330N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
6330N/A ! To view a copy of this license, visit
6330N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
6330N/A ! or send a letter to Creative Commons, 444 Castro Street,
6330N/A ! Suite 900, Mountain View, California, 94041, USA.
6330N/A !
6330N/A ! You can also obtain a copy of the license at
6330N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
6330N/A ! See the License for the specific language governing permissions
6330N/A ! and limitations under the License.
6330N/A !
6330N/A ! If applicable, add the following below this CCPL HEADER, with the fields
6330N/A ! enclosed by brackets "[]" replaced with your own identifying information:
6330N/A ! Portions Copyright [yyyy] [name of copyright owner]
6330N/A !
6330N/A ! CCPL HEADER END
6330N/A !
6330N/A ! Copyright 2011-2012 ForgeRock AS
6330N/A !
6330N/A-->
6330N/A<refentry xml:id="base64-1" xmlns="http://docbook.org/ns/docbook" version="5.0"
6330N/A xml:lang="en" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6330N/A xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
6330N/A xmlns:xlink="http://www.w3.org/1999/xlink"
6330N/A xmlns:xi="http://www.w3.org/2001/XInclude">
6330N/A <xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
6330N/A <refmeta>
6330N/A <refentrytitle><application>base64</application></refentrytitle>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
6330N/A </refmeta>
6330N/A <refnamediv>
6330N/A <refname><application>base64</application></refname>
6330N/A <refpurpose>encode and decode base64 strings</refpurpose>
6330N/A </refnamediv>
6330N/A <refsynopsisdiv>
6330N/A <cmdsynopsis>
6330N/A <command>base64</command>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/A </cmdsynopsis>
6330N/A <cmdsynopsis>
6330N/A <command>base64</command> <arg choice="plain">decode</arg>
6330N/A <group choice="opt">
6330N/A <arg choice="plain">-d <replaceable class="parameter">encoded_string</replaceable></arg>
6330N/A <arg choice="plain">-f <replaceable class="parameter">encoded_file</replaceable></arg>
6330N/A </group>
6330N/A <arg>-o <replaceable class="parameter">outfile</replaceable></arg>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/A </cmdsynopsis>
6330N/A <cmdsynopsis>
6330N/A <command>base64</command> <arg choice="plain">encode</arg>
6330N/A <group choice="opt">
6330N/A <arg choice="plain">-d <replaceable class="parameter">string</replaceable></arg>
6330N/A <arg choice="plain">-f <replaceable class="parameter">file</replaceable></arg>
6330N/A </group>
6330N/A <arg>-o <replaceable class="parameter">outfile</replaceable></arg>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/A </cmdsynopsis>
6330N/A </refsynopsisdiv>
6330N/A <refsection>
6330N/A <title>Description</title>
6330N/A <para>
6330N/AThis utility can be used to encode and decode information using base64. If no
6330N/Ainput source (string or file) is given, the utility reads the data from the
6330N/Astandard inut.
6330N/AIf no output destination (file) is given, the utility writes the result to the
6330N/Astandard output.
6330N/A </para>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Subcommands</title>
6330N/A <para>
6330N/AThe following subcommands are supported.
6330N/A </para>
6330N/A <variablelist>
6330N/A <varlistentry>
6330N/A <term><command>decode</command></term>
6330N/A <listitem>
6330N/A <para>
6330N/ADecode base64-encoded information into raw data.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><command>encode</command></term>
6330N/A <listitem>
6330N/A <para>
6330N/AEncode raw data using base64.</para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Options</title>
6330N/A <para>
6330N/AThe following options are supported.
6330N/A </para>
6330N/A <variablelist>
6330N/A <varlistentry>
6330N/A <term><option>-d</option> <replaceable class="parameter">string</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AThe string which should be decoded or encoded, depending on the given subcommand.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-f</option> <replaceable class="parameter">file</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AThe name of the file, whose content should be decoded or encoded, depending on
6330N/Athe the given subcommand.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-o</option> <replaceable class="parameter">file</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AThe name of the file, where the result of this operation, i.e. the encoded or
6330N/Adecoded data should be written.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>General Options</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-general"]/*)'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Examples</title>
6330N/A <informalexample>
6330N/A <para>
6330N/AThe following command shows the changes from the external change log in
6330N/Ahuman-readable format.
6330N/A </para>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>base64 decode -d YWRkOiBkZXNjcmlwdGlvbgpkZXNjcmlwdGlvbjogQSB0aGlyZCBjaGFuZ2UKLQpyZXBsYWNlOiBtb2RpZmllcnNOYW1lCm1vZGlmaWVyc05hbWU6IGNuPURpcmVjdG9yeSBNYW5hZ2VyLGNuPVJvb3QgRE5zLGNuPWNvbmZpZwotCnJlcGxhY2U6IG1vZGlmeVRpbWVzdGFtcAptb2RpZnlUaW1lc3RhbXA6IDIwMTEwNjEzMDcxMjEwWgotCg==</command></literallayout>
6330N/A <screen>
6330N/Aadd: description
6330N/Adescription: A third change
6330N/A-
6330N/Areplace: modifiersName
6330N/AmodifiersName: cn=Directory Manager,cn=Root DNs,cn=config
6330N/A-
6330N/Areplace: modifyTimestamp
6330N/AmodifyTimestamp: 20110613071210Z
6330N/A-
6330N/A</screen>
6330N/A </informalexample>
6330N/A </refsection>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="exit-0-gt0"])'/>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>
6330N/A</refentry>