refEntry.ftl revision 27d398c0bcca6adaf643fa3f6fd02ed67ff4adf1
<#--
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License, Version 1.0 only
# (the "License"). You may not use this file except in compliance
# with the License.
#
# You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
# or http://forgerock.org/license/CDDLv1.0.html.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at legal-notices/CDDLv1_0.txt.
# If applicable, add the following below this CDDL HEADER,
# with the fields enclosed by brackets "[]" replaced
# with your own identifying information:
#
# Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
# Copyright 2015 ForgeRock AS.
#
#-->
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CCPL HEADER START
!
! This work is licensed under the Creative Commons
! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
! To view a copy of this license, visit
! http://creativecommons.org/licenses/by-nc-nd/3.0/
! or send a letter to Creative Commons, 444 Castro Street,
! Suite 900, Mountain View, California, 94041, USA.
!
! You can also obtain a copy of the license at
! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
! See the License for the specific language governing permissions
! and limitations under the License.
!
! If applicable, add the following below this CCPL HEADER, with the fields
! enclosed by brackets "[]" replaced with your own identifying information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CCPL HEADER END
!
! Copyright 2011-${year} ForgeRock AS.
!
-->
<refentry xml:id="${name}-1"
xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="${locale}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook
http://docbook.org/xml/5.0/xsd/docbook.xsd"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xinclude="http://www.w3.org/2001/XInclude">
<info>
<copyright>
<year>2011-${year}</year>
<holder>ForgeRock AS.</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>${name}</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
<refmiscinfo class="version">${r"${project.version}"}</refmiscinfo>
</refmeta>
<refnamediv>
<refname>${name}</refname>
<refpurpose>${shortDesc}</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>${name}</command>
<arg choice="plain">${args}</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="${name}-description">
<title>${descTitle}</title>
<para>
${description}
</para>
<#if info??>${info}</#if>
</refsect1>
<#if options??>
<refsect1>
<title>${optsTitle}</title>
<variablelist>
<para>
${optsIntro}
</para>
<#list options as option>
<varlistentry>
<term><option>${option.synopsis?xml}</option></term>
<listitem>
<para>
${option.description}
</para>
<#if option.default??>
<para>
${option.default}
</para>
</#if>
<#if option.info??>${option.info}</#if>
</listitem>
</varlistentry>
</#list>
</variablelist>
</refsect1>
</#if>
<!-- TODO: subcommands -->
<!-- TODO: filter -->
<!-- TODO: attribute -->
<!-- TODO: exitCodes -->
<!-- TODO: files -->
<!-- TODO: examples -->
<!-- TODO: seeAlso -->
</refentry>