51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark<?xml version="1.0" encoding="UTF-8"?>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark<!--
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! CCPL HEADER START
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark !
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! This work is licensed under the Creative Commons
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! To view a copy of this license, visit
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! http://creativecommons.org/licenses/by-nc-nd/3.0/
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! or send a letter to Creative Commons, 444 Castro Street,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! Suite 900, Mountain View, California, 94041, USA.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark !
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! You can also obtain a copy of the license at
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! See the License for the specific language governing permissions
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! and limitations under the License.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark !
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! If applicable, add the following below this CCPL HEADER, with the fields
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! enclosed by brackets "[]" replaced with your own identifying information:
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! Portions Copyright [yyyy] [name of copyright owner]
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark !
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! CCPL HEADER END
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark !
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! Copyright 2011-2013 ForgeRock AS
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark !
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark-->
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <section xml:id="formatting-conventions"
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xmlns:xlink='http://www.w3.org/1999/xlink'
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xmlns:xinclude='http://www.w3.org/2001/XInclude'>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <title>Formatting Conventions</title>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Some items are formatted differently from other text, like
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <filename>filenames</filename>, <command>commands</command>, and
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <literal>literal values</literal>.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <screen>$ echo Command line sessions are formatted with lines folded for easier reading.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark In HTML documents click the [-] image for a flat, copy-paste version. Click
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the [+] image for an expanded, line-wrapped version. &gt; /dev/null</screen>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>In many cases, sections pertaining to UNIX, GNU/Linux, Mac OS X, BSD,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark and so forth are marked (UNIX). Sections pertaining to Microsoft Windows
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark might be marked (Windows). To avoid repetition, however, file system
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark directory names are often given only in UNIX format as in
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <filename>/path/to/opendj</filename>, even if the text applies to
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <filename>C:\path\to\opendj</filename> as well.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Absolute path names usually begin with the placeholder
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <filename>/path/to/</filename>, which might translate to
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <filename>/opt/</filename>, <filename>C:\Program Files\</filename>, or
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark somewhere else on your system. Unless you install from native packages,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark you create this location before you install.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <programlisting language='java'>class Test {
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark public static void main(String [] args) {
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark System.out.println("This is a program listing.");
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark }
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark}</programlisting>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark</section>