Blame Artworks/Docs/Docbook/Tcar-ug/Scripts/Bash/help.docbook

Alain Reguera Delgado 46de3c
<refentry id="scripts-bash-help">
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refmeta>
Alain Reguera Delgado 46de3c
        <refentrytitle>help</refentrytitle>
Alain Reguera Delgado 46de3c
        <indexterm type="common-function">
Alain Reguera Delgado 46de3c
            <primary>Standardize constructions tasks inside &TCAR;</primary>
Alain Reguera Delgado 46de3c
        </indexterm>
Alain Reguera Delgado 46de3c
    </refmeta>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refnamediv>
Alain Reguera Delgado 46de3c
        <refname>help</refname>
Alain Reguera Delgado 46de3c
        <refpurpose>Standardize documentation tasks inside &TCAR;.</refpurpose>
Alain Reguera Delgado 46de3c
    </refnamediv>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsynopsisdiv>
Alain Reguera Delgado 46de3c
    <cmdsynopsis>
Alain Reguera Delgado 46de3c
        <command>centos-art help</command> 
Alain Reguera Delgado 46de3c
        <arg choice="opt">
Alain Reguera Delgado 46de3c
            <arg>-h|--help</arg>
Alain Reguera Delgado 46de3c
            <arg>-q|--quiet</arg>
Alain Reguera Delgado 46de3c
            <arg>--answer-yes</arg>
Alain Reguera Delgado 46de3c
            <arg>--synchronize</arg>
Alain Reguera Delgado 46de3c
            <arg>--format="<replaceable>KEYWORD</replaceable>"</arg>
Alain Reguera Delgado 46de3c
            <arg>--search="<replaceable>KEYWORD</replaceable>"</arg>
Alain Reguera Delgado 46de3c
            <arg>--edit</arg>
Alain Reguera Delgado 46de3c
            <arg>--read</arg>
Alain Reguera Delgado 46de3c
            <arg>--update-output</arg>
Alain Reguera Delgado 46de3c
            <arg>--update-structure</arg>
Alain Reguera Delgado 46de3c
            <arg>--copy</arg>
Alain Reguera Delgado 46de3c
            <arg>--delete</arg>
Alain Reguera Delgado 46de3c
            <arg>--rename</arg>
Alain Reguera Delgado 46de3c
        </arg>
Alain Reguera Delgado 46de3c
        <group choice="req">
Alain Reguera Delgado 46de3c
        <arg rep="repeat"><replaceable>MANUAL</replaceable>:<replaceable>PART</replaceable>:<replaceable>CHAPTER</replaceable>:<replaceable>SECTION</replaceable></arg>
Alain Reguera Delgado 46de3c
        <arg rep="repeat"><replaceable>LOCATION</replaceable></arg>
Alain Reguera Delgado 46de3c
        </group>
Alain Reguera Delgado 46de3c
    </cmdsynopsis>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    </refsynopsisdiv>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-description">
Alain Reguera Delgado 46de3c
    <title>Description</title>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        The <function>help</function> functionality exists to create
Alain Reguera Delgado 46de3c
        and maintain documentation manuals inside &TCAR;.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-description-docentry">
Alain Reguera Delgado 46de3c
    <title>Documentation Entries</title>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        The documentation entry identifies the specific file you want
Alain Reguera Delgado 46de3c
        to work with inside a documentation manual. The help
Alain Reguera Delgado 46de3c
        functionality recognizes documentation entries in the
Alain Reguera Delgado 46de3c
        following formats:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    <variablelist>
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term>Path style</term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        This format uses paths to represent the documentation entries
Alain Reguera Delgado 46de3c
        you want to work with.  This format assumes you are using the
Alain Reguera Delgado 46de3c
        first path component as chapter and the rest of the path as
Alain Reguera Delgado 46de3c
        section identifier both inside <quote>tcar-fs</quote>
Alain Reguera Delgado 46de3c
        documentation manual as parent documentation structure. The
Alain Reguera Delgado 46de3c
        field related to the part sectioning structure in the
Alain Reguera Delgado 46de3c
        documentation entry (the second field) is assumed empty, as
Alain Reguera Delgado 46de3c
        well. For example, if you want to document the directory
Alain Reguera Delgado 46de3c
        <quote>
Alain Reguera Delgado 46de3c
        class="directory">Scripts/Bash/Functions/Help</filename></quote>,
Alain Reguera Delgado 46de3c
        then you can do it with the following command:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <cmdsynopsis>
Alain Reguera Delgado 46de3c
    <command>centos-art help --edit Scripts/Bash/Functions/Help</command>
Alain Reguera Delgado 46de3c
    </cmdsynopsis>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term>Colon style</term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        This format uses colons to represent the documentation entries
Alain Reguera Delgado 46de3c
        you want to work with. In this format, the whole documentation
Alain Reguera Delgado 46de3c
        entry is divided in fields using colon as separator character.
Alain Reguera Delgado 46de3c
        Documentation entries written this way use each field to
Alain Reguera Delgado 46de3c
        specify manual, part, chapter and section identifiers (in this
Alain Reguera Delgado 46de3c
        order). The section identifier can use a path style or hyphen
Alain Reguera Delgado 46de3c
        style to separate
Alain Reguera Delgado 46de3c
        components. For example, if you want to document the directory
Alain Reguera Delgado 46de3c
        <quote>
Alain Reguera Delgado 46de3c
        class="directory">Scripts/Bash/Functions/Help</filename></quote>,
Alain Reguera Delgado 46de3c
        then you can do it with any of the following commands:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <cmdsynopsis>
Alain Reguera Delgado 46de3c
    <command>centos-art help --edit tcar-fs::trunk:Scripts/Bash/Functions/Help</command>
Alain Reguera Delgado 46de3c
    <command>centos-art help --edit tcar-fs::trunk:scripts-bash-functions-help</command>
Alain Reguera Delgado 46de3c
    </cmdsynopsis>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        The documentation manual name specified in the first field of
Alain Reguera Delgado 46de3c
        a colon style documentation entry, must match the name the
Alain Reguera Delgado 46de3c
        name of the directory where the documentation manual is stored
Alain Reguera Delgado 46de3c
        in. By default documentation manuals are written in
Alain Reguera Delgado 46de3c
        Documentation/Models/Texinfo or
Alain Reguera Delgado 46de3c
        Documentation/Models/Docbook directories, based on
Alain Reguera Delgado 46de3c
        whether they are written in Texinfo or Docbook documentation
Alain Reguera Delgado 46de3c
        format. 
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        The match relation between the manual name you provide in the
Alain Reguera Delgado 46de3c
        documentation entry and the related directory name inside
Alain Reguera Delgado 46de3c
        &TCAR; is case insensitive. The same is true for all other
Alain Reguera Delgado 46de3c
        documentation entry fields.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
    </variablelist>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        From these documentation entry formats, the colon style
Alain Reguera Delgado 46de3c
        provides more flexibility than path style does. You can use
Alain Reguera Delgado 46de3c
        documentation entries written in colon style to create and
Alain Reguera Delgado 46de3c
        maintain different documentation manuals, including the
Alain Reguera Delgado 46de3c
        <quote>tcar-fs</quote> documentation manual. This is something
Alain Reguera Delgado 46de3c
        you cannot do with documentation entries written in path style
Alain Reguera Delgado 46de3c
        because they confine all documentation actions to
Alain Reguera Delgado 46de3c
        <quote>tcar-fs</quote> documentation manual.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-options">
Alain Reguera Delgado 46de3c
    <title>Options</title>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        The <command>centos-art help</command> command accepts common
Alain Reguera Delgado 46de3c
        options described in 
Alain Reguera Delgado 46de3c
        linkend="scripts-bash-cliref-options" /> and the following
Alain Reguera Delgado 46de3c
        specific options:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <variablelist>
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term><option>--answer-yes</option></term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Assume <emphasis>yes</emphasis> to all confirmation requests.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term><option>--synchronize</option></term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Synchronizes available changes between the working copy and
Alain Reguera Delgado 46de3c
        the central repository.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term><option>--format="<replaceable>KEYWORD</replaceable>"</option></term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Specifies the format of documentation entry source file. This
Alain Reguera Delgado 46de3c
        information is used as reference to build the absolute path of
Alain Reguera Delgado 46de3c
        documentation entry, so you always have to provide it in order
Alain Reguera Delgado 46de3c
        to reach the documentation entry you want to work with.
Alain Reguera Delgado 46de3c
        Possible values for this option are shown in 
Alain Reguera Delgado 46de3c
        linkend="scripts-bash-help-supportedformats" />. When none of
Alain Reguera Delgado 46de3c
        these values is passed as format, Texinfo is used as default
Alain Reguera Delgado 46de3c
        format.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    
Alain Reguera Delgado 46de3c
    <title>Documentation formats</title>
Alain Reguera Delgado 46de3c
    <tgroup cols="3" align="left">
Alain Reguera Delgado 46de3c
    
Alain Reguera Delgado 46de3c
        <row>
Alain Reguera Delgado 46de3c
            <entry>Keyword</entry>
Alain Reguera Delgado 46de3c
            <entry>Description</entry>
Alain Reguera Delgado 46de3c
            <entry>Supported</entry>
Alain Reguera Delgado 46de3c
        </row>
Alain Reguera Delgado 46de3c
    
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    
Alain Reguera Delgado 46de3c
        <row>
Alain Reguera Delgado 46de3c
            <entry><literal>texinfo</literal></entry>
Alain Reguera Delgado 46de3c
            <entry><xref linkend="manuals-formats-texinfo"/></entry>
Alain Reguera Delgado 46de3c
            <entry>Yes</entry>
Alain Reguera Delgado 46de3c
        </row>
Alain Reguera Delgado 46de3c
        <row>
Alain Reguera Delgado 46de3c
            <entry><literal>docbook</literal></entry>
Alain Reguera Delgado 46de3c
            <entry><xref linkend="manuals-formats-docbook"/></entry>
Alain Reguera Delgado 46de3c
            <entry>No</entry>
Alain Reguera Delgado 46de3c
        </row>
Alain Reguera Delgado 46de3c
        <row>
Alain Reguera Delgado 46de3c
            <entry><literal>latex</literal></entry>
Alain Reguera Delgado 46de3c
            <entry><xref linkend="manuals-formats-latex"/></entry>
Alain Reguera Delgado 46de3c
            <entry>No</entry>
Alain Reguera Delgado 46de3c
        </row>
Alain Reguera Delgado 46de3c
        <row>
Alain Reguera Delgado 46de3c
            <entry><literal>linuxdoc</literal></entry>
Alain Reguera Delgado 46de3c
            <entry>...</entry>
Alain Reguera Delgado 46de3c
            <entry>No</entry>
Alain Reguera Delgado 46de3c
        </row>
Alain Reguera Delgado 46de3c
    
Alain Reguera Delgado 46de3c
    
Alain Reguera Delgado 46de3c
    </tgroup>
Alain Reguera Delgado 46de3c
    
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term><option>--search="<replaceable>KEYWORD</replaceable>"</option></term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Looks for documentation entries that match the
Alain Reguera Delgado 46de3c
        <replaceable>KEYWORD</replaceable> specified as value and
Alain Reguera Delgado 46de3c
        display them one by one in the order they were found. The way
Alain Reguera Delgado 46de3c
        each documentation entry is presented to you depends on the
Alain Reguera Delgado 46de3c
        documentation format the related documentation manual was
Alain Reguera Delgado 46de3c
        written on.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term><option>--edit</option></term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Edit the documentation entry provided as argument.  The
Alain Reguera Delgado 46de3c
        edition itself takes place through your default text editor
Alain Reguera Delgado 46de3c
        (e.g., the one you specified in the <envar>EDITOR</envar>
Alain Reguera Delgado 46de3c
        environment variable) one file at a time (i.e., the queue of
Alain Reguera Delgado 46de3c
        files to edit is not loaded in the text editor.).
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        When parent components inside documentation entries doesn't
Alain Reguera Delgado 46de3c
        exist (e.g., you try to create a section for a documentation
Alain Reguera Delgado 46de3c
        manual that doesn't exist), the <function>help</function>
Alain Reguera Delgado 46de3c
        functionality will create all documentation parent structures
Alain Reguera Delgado 46de3c
        considering the documentation format constraints and the
Alain Reguera Delgado 46de3c
        following document structure hierarchy order: documentation
Alain Reguera Delgado 46de3c
        <quote>manual</quote> first, <quote>parts</quote> second,
Alain Reguera Delgado 46de3c
        <quote>chapters</quote> third and <quote>sections</quote>
Alain Reguera Delgado 46de3c
        lastly.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term><option>--read</option></term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Read the documentation entry provided as argument.  This
Alain Reguera Delgado 46de3c
        option is used internally by <command>centos-art.sh</command>
Alain Reguera Delgado 46de3c
        script to refer documentation based on errors, so you can know
Alain Reguera Delgado 46de3c
        more about them and the causes that could have provoked them.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term><option>--update-output</option></term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Update output files rexporting them from the specified backend
Alain Reguera Delgado 46de3c
        source files.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term><option>--update-structure</option></term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Update document structure (e.g., cross references, menus,
Alain Reguera Delgado 46de3c
        nodes, etc.) and should be passed with a section as
Alain Reguera Delgado 46de3c
        documentation entry.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        This option should be used whenever a document structure
Alain Reguera Delgado 46de3c
        changes (e.g., documentation entries are added, copied,
Alain Reguera Delgado 46de3c
        renamed, deleted, etc.). This option grantees the document
Alain Reguera Delgado 46de3c
        integrity and should be run before updating documentation
Alain Reguera Delgado 46de3c
        manual final output files.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term><option>--copy</option></term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Duplicate documentation entries inside the working copy using
Alain Reguera Delgado 46de3c
        version control.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        When you duplicate documentation entries through this option,
Alain Reguera Delgado 46de3c
        you should pass only two documentation entries in the command
Alain Reguera Delgado 46de3c
        line.  The first one is considered the source location and
Alain Reguera Delgado 46de3c
        should point to a file under version control inside the
Alain Reguera Delgado 46de3c
        working copy. The second one is considered the target location
Alain Reguera Delgado 46de3c
        and should point either to the same structural level the
Alain Reguera Delgado 46de3c
        source points to or a direct parent level based on source
Alain Reguera Delgado 46de3c
        location, as described below.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <variablelist>
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term>
Alain Reguera Delgado 46de3c
        "<replaceable>manual:part:chapter:section1</replaceable>" "<replaceable>manual:part:chapter:section2</replaceable>"</term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Duplicates <replaceable>section1</replaceable> as
Alain Reguera Delgado 46de3c
        <replaceable>section2</replaceable> inside the same
Alain Reguera Delgado 46de3c
        <replaceable>chapter</replaceable>,
Alain Reguera Delgado 46de3c
        <replaceable>part</replaceable> and
Alain Reguera Delgado 46de3c
        <replaceable>manual</replaceable>.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term>
Alain Reguera Delgado 46de3c
        "<replaceable>manual:part:chapter1:</replaceable>" "<replaceable>manual:part:chapter2:</replaceable>"</term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Duplicates <replaceable>chapter1</replaceable> as
Alain Reguera Delgado 46de3c
        <replaceable>chapter2</replaceable> inside the same
Alain Reguera Delgado 46de3c
        <replaceable>part</replaceable> and
Alain Reguera Delgado 46de3c
        <replaceable>manual</replaceable>.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term>
Alain Reguera Delgado 46de3c
        "<replaceable>manual:part1::</replaceable>" "<replaceable>manual:part2::</replaceable>"</term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Duplicates <replaceable>part1</replaceable> as
Alain Reguera Delgado 46de3c
        <replaceable>part2</replaceable> inside the same
Alain Reguera Delgado 46de3c
        <replaceable>manual</replaceable>.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term>
Alain Reguera Delgado 46de3c
        "<replaceable>manual1:::</replaceable>" "<replaceable>manual2:::</replaceable>"</term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Duplicates <replaceable>manual1</replaceable> as
Alain Reguera Delgado 46de3c
        <replaceable>manual2</replaceable> inside 
Alain Reguera Delgado 46de3c
        class="directory">Documentation/Models/${FLAG_FORMAT}/</filename>
Alain Reguera Delgado 46de3c
        directory, where ${FLAG_FORMAT} is the name of the format
Alain Reguera Delgado 46de3c
        passed as option with the first letter in uppercase and the
Alain Reguera Delgado 46de3c
        rest in lowercase.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
    </variablelist>
Alain Reguera Delgado 46de3c
    
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        When you copy documentation entries through this option, all
Alain Reguera Delgado 46de3c
        structuring sections inside the one copied will be also
Alain Reguera Delgado 46de3c
        copied. For example, if you copy a documentation manual that
Alain Reguera Delgado 46de3c
        is made of parts, chapters and sections, the duplicated manual
Alain Reguera Delgado 46de3c
        will contain all those parts, chapters and sections, as well.
Alain Reguera Delgado 46de3c
        The same is true for lower sectioning structures. Thus, you
Alain Reguera Delgado 46de3c
        can be more specific in the documentation entry by reducing
Alain Reguera Delgado 46de3c
        the amount of content to duplicate.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        When you copy documentation entries through this option, you
Alain Reguera Delgado 46de3c
        do it using documentation entries in the same structural level
Alain Reguera Delgado 46de3c
        only. This option doesn't support copying documentation
Alain Reguera Delgado 46de3c
        entries from differnet structural levels. For example, you
Alain Reguera Delgado 46de3c
        cannot copy one section to a chapter different from that the
Alain Reguera Delgado 46de3c
        source section you specified belongs to. The same applies to
Alain Reguera Delgado 46de3c
        chapters, and parts.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        When you copy documentation entries through this option, the
Alain Reguera Delgado 46de3c
        source documentation entry you specify must not contain
Alain Reguera Delgado 46de3c
        pending changes.  Otherwise, the target section won't be
Alain Reguera Delgado 46de3c
        created and the script will immediatly stop its execution with
Alain Reguera Delgado 46de3c
        a <quote>The source location has pending changes.</quote>
Alain Reguera Delgado 46de3c
        error message.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term><option>--delete</option></term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Delete documentation entries. It is possible to delete more
Alain Reguera Delgado 46de3c
        than one documentation entry by specifying several
Alain Reguera Delgado 46de3c
        documentation entries in the command line.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        When you delete documentation entries, you can pass any number
Alain Reguera Delgado 46de3c
        of documentation entries as argument. The documentation
Alain Reguera Delgado 46de3c
        entries you provide will be processed one by one.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        When you delete a documentation entry from a documentation
Alain Reguera Delgado 46de3c
        manual, all cross references pointing to the deleted
Alain Reguera Delgado 46de3c
        documentation entry will be transformed into something
Alain Reguera Delgado 46de3c
        different to point out the fact that the related documentation
Alain Reguera Delgado 46de3c
        entry has been removed from the documentation manual and
Alain Reguera Delgado 46de3c
        restored back if you create the deleted section again. The
Alain Reguera Delgado 46de3c
        purpose of this is to keep the documentation manual structure
Alain Reguera Delgado 46de3c
        in a consistent state.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <varlistentry>
Alain Reguera Delgado 46de3c
    <term><option>--rename</option></term>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Rename documentation entries inside the working copy. This
Alain Reguera Delgado 46de3c
        option copies the source documentation entry to its target
Alain Reguera Delgado 46de3c
        location, removes the source documentation entry, and restores
Alain Reguera Delgado 46de3c
        removed cross references renaming them to point the specified
Alain Reguera Delgado 46de3c
        target documentation entry.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        When you rename documentation entries, it is required to pass
Alain Reguera Delgado 46de3c
        only two non-option parameters to the command-line. The first
Alain Reguera Delgado 46de3c
        non-option parameter is considered the source location and the
Alain Reguera Delgado 46de3c
        second one the target location.  Both source location and
Alain Reguera Delgado 46de3c
        target location must point to a directory under version
Alain Reguera Delgado 46de3c
        control inside the working copy.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </varlistentry>
Alain Reguera Delgado 46de3c
    </variablelist>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-examples">
Alain Reguera Delgado 46de3c
    <title>Examples</title>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        This section describes, using examples, the procedure you
Alain Reguera Delgado 46de3c
        should follow to manage documentation manuals through
Alain Reguera Delgado 46de3c
        <function>help</function> functionality inside &TCAR;. To
Alain Reguera Delgado 46de3c
        better understand the procedure to follow, it describes  a
Alain Reguera Delgado 46de3c
        hypothetical documentation scenario and the related commands
Alain Reguera Delgado 46de3c
        and outputs you may go through in order to complete specific
Alain Reguera Delgado 46de3c
        documentation tasks successfully.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-description-create">
Alain Reguera Delgado 46de3c
    <title>Creating Document Structures</title>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        To create new documentation manuals inside &TCAR; you need to
Alain Reguera Delgado 46de3c
        provide both <option>--edit</option> and
Alain Reguera Delgado 46de3c
        <option>--format</option> options as well as a documentation
Alain Reguera Delgado 46de3c
        entry in the form <quote><literal>manual:::</literal></quote>
Alain Reguera Delgado 46de3c
        to the <function>help</function> functionality.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        For example, consider a scenario where you need to create a
Alain Reguera Delgado 46de3c
        documentation manual in texinfo format to describe different
Alain Reguera Delgado 46de3c
        maintenance tasks you need to realized in order to keep your
Alain Reguera Delgado 46de3c
        pets happy. We'll name such manual <quote>My Zoo</quote>. It
Alain Reguera Delgado 46de3c
        will use chapters to organize each different kind of pets you
Alain Reguera Delgado 46de3c
        have.  Inside chapters, sections will have the pet's name as
Alain Reguera Delgado 46de3c
        their own name to describe each pet's requirements, schedules,
Alain Reguera Delgado 46de3c
        and so on.  To create such documentation manual, run the
Alain Reguera Delgado 46de3c
        following command:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <cmdsynopsis>
Alain Reguera Delgado 46de3c
    <command>centos-art help --edit --format="texinfo" "myzoo:::"</command>
Alain Reguera Delgado 46de3c
    </cmdsynopsis>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        In case such documentation manual doesn't exist in the
Alain Reguera Delgado 46de3c
        
Alain Reguera Delgado 46de3c
        class="directory">Docuementation/Models/Texinfo/</filename>
Alain Reguera Delgado 46de3c
        directory, this command will produce the following output:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
<programlisting>
Alain Reguera Delgado 46de3c
The following documentation manual doesn't exist:
Alain Reguera Delgado 46de3c
--> Documentation/Models/Texinfo/Myzoo/en_US/myzoo.texinfo
Alain Reguera Delgado 46de3c
Do you want to create it now? [yes/no]: yes
Alain Reguera Delgado 46de3c
Enter manual's title: My Zoo
Alain Reguera Delgado 46de3c
Enter manual's subtitle: Reference
Alain Reguera Delgado 46de3c
Enter manual's abstract: This manual describes my zoo maintenance tasks.
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/myzoo.conf
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/myzoo-index.texinfo
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/myzoo-menu.texinfo
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/myzoo-nodes.texinfo
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/myzoo.texinfo
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/Licenses/chapter-menu.texinfo
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/Licenses/chapter-nodes.texinfo
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/Licenses/chapter.texinfo
Alain Reguera Delgado 46de3c
Updating        Documentation/Models/Texinfo/Myzoo/en_US/myzoo.texinfo
Alain Reguera Delgado 46de3c
Creating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.info.bz2
Alain Reguera Delgado 46de3c
Creating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.xhtml.tar.bz2
Alain Reguera Delgado 46de3c
Creating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.xml
Alain Reguera Delgado 46de3c
Creating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.docbook
Alain Reguera Delgado 46de3c
Creating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.pdf
Alain Reguera Delgado 46de3c
Creating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.txt.bz2
Alain Reguera Delgado 46de3c
</programlisting>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Once the documentation structure has been created this way,
Alain Reguera Delgado 46de3c
        the recently created documentation manual is ready to receive
Alain Reguera Delgado 46de3c
        new sectioning levels (e.g., parts, chapters, sections, etc.).
Alain Reguera Delgado 46de3c
        For example, to create a new chapter named
Alain Reguera Delgado 46de3c
        <quote>Turtles</quote> inside <quote>My Zoo</quote>
Alain Reguera Delgado 46de3c
        documentation manual, run the following command:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <cmdsynopsis>
Alain Reguera Delgado 46de3c
    <command>centos-art help --edit --format="texinfo" "myzoo::turtles:"</command>
Alain Reguera Delgado 46de3c
    </cmdsynopsis>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
<programlisting>
Alain Reguera Delgado 46de3c
The following documentation chapter doesn't exist:
Alain Reguera Delgado 46de3c
--> Documentation/Models/Texinfo/Myzoo/en_US/Turtles
Alain Reguera Delgado 46de3c
Do you want to create it now? [yes/no]: yes
Alain Reguera Delgado 46de3c
Enter chapter's title: Turtles
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/Turtles
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/Turtles/chapter-menu.texinfo
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/Turtles/chapter-nodes.texinfo
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/Turtles/chapter.texinfo
Alain Reguera Delgado 46de3c
Updating        Documentation/Models/Texinfo/Myzoo/en_US/myzoo-menu.texinfo
Alain Reguera Delgado 46de3c
Updating        Documentation/Models/Texinfo/Myzoo/en_US/myzoo-nodes.texinfo
Alain Reguera Delgado 46de3c
Updating        Documentation/Models/Texinfo/Myzoo/en_US/Turtles/chapter.texinfo
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.info.bz2
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.xhtml.tar.bz2
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.xml
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.docbook
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.pdf
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.txt.bz2
Alain Reguera Delgado 46de3c
</programlisting>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Once chapters have been created it is possible to create
Alain Reguera Delgado 46de3c
        sections inside them.  For example, if you want to create a
Alain Reguera Delgado 46de3c
        section for describing the life of a turtle named Longneck,
Alain Reguera Delgado 46de3c
        run the following command:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <cmdsynopsis>
Alain Reguera Delgado 46de3c
    <command>centos-art help --edit --format="texinfo" "myzoo::turtles:longneck"</command>
Alain Reguera Delgado 46de3c
    </cmdsynopsis>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
<programlisting>
Alain Reguera Delgado 46de3c
The following documentation section doesn't exist:
Alain Reguera Delgado 46de3c
--> Documentation/Models/Texinfo/Myzoo/en_US/Turtles/longneck.texinfo
Alain Reguera Delgado 46de3c
Do you want to create it now? [yes/no]: yes
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/Turtles/longneck.texinfo
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.info.bz2
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.xhtml.tar.bz2
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.xml
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.docbook
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.pdf
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.txt.bz2
Alain Reguera Delgado 46de3c
</programlisting>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-description-edit">
Alain Reguera Delgado 46de3c
    <title>Editing Document Structures</title>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        To edit documentation entries you can follow the same
Alain Reguera Delgado 46de3c
        procedure described above. Just keep in mind the following
Alain Reguera Delgado 46de3c
        rules:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    
Alain Reguera Delgado 46de3c
    <itemizedlist>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        When the entry you want to edit already exist it will be
Alain Reguera Delgado 46de3c
        edited.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
     When the entry you want to edit doesn't exist it will be created
Alain Reguera Delgado 46de3c
     first and edited later.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    </itemizedlist>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-description-copy">
Alain Reguera Delgado 46de3c
    <title>Copying Document Structures</title>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Consider a new turtle named Slowfeet has arrived to your home
Alain Reguera Delgado 46de3c
        and you want to duplicate Longneck's section for it (they both
Alain Reguera Delgado 46de3c
        are turtles and have similar requirements, squedules, etc.).
Alain Reguera Delgado 46de3c
        To copy documentation entries you use the
Alain Reguera Delgado 46de3c
        <option>--copy</option> option with two documentation entries,
Alain Reguera Delgado 46de3c
        where the first one is the source location and the second one
Alain Reguera Delgado 46de3c
        the target location.  To do this, run the following command:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <cmdsynopsis>
Alain Reguera Delgado 46de3c
    <command>centos-art help --copy --format="texinfo" "myzoo::turtles:longneck" "myzoo::turtles:slowfeet"</command>
Alain Reguera Delgado 46de3c
    </cmdsynopsis>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
<programlisting>
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/Myzoo/en_US/Turtles/slowfeet.texinfo
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.info.bz2
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.xhtml.tar.bz2
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.xml
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.docbook
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.pdf
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/Myzoo/en_US/myzoo.txt.bz2
Alain Reguera Delgado 46de3c
</programlisting>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-description-rename">
Alain Reguera Delgado 46de3c
    <title>Renaming Document Structures</title>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Consider you've created the section of Longneck turtle using
Alain Reguera Delgado 46de3c
        the following documentation entry format
Alain Reguera Delgado 46de3c
        <quote>myzoo::turtles:longnek</quote>, but you didn't notice
Alain Reguera Delgado 46de3c
        the typo in it. You've made cross references to the misspelled
Alain Reguera Delgado 46de3c
        section in a few pages inside the <quote>My Zoo</quote>
Alain Reguera Delgado 46de3c
        documentation manual and some time later you realize the
Alain Reguera Delgado 46de3c
        section name has a spelling problem.  To fix such a problem
Alain Reguera Delgado 46de3c
        you can rename the misspelled section with the correct one
Alain Reguera Delgado 46de3c
        running the following command:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <cmdsynopsis>
Alain Reguera Delgado 46de3c
    <command>centos-art help --rename --format="texinfo" "myzoo::turtles:longnek" "myzoo::turtles:longneck"</command>
Alain Reguera Delgado 46de3c
    </cmdsynopsis>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
<programlisting>
Alain Reguera Delgado 46de3c
Creating        Documentation/Models/Texinfo/MyZoo/en_US/Turtles/longneck.texinfo
Alain Reguera Delgado 46de3c
Deleting        Documentation/Models/Texinfo/MyZoo/en_US/Turtles/longnek.texinfo
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.info.bz2
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.xhtml.tar.bz2
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.xml
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.docbook
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.pdf
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.txt.bz2
Alain Reguera Delgado 46de3c
</programlisting>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        ...
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-description-delete">
Alain Reguera Delgado 46de3c
    <title>Deleting Document Structures</title>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Consider you gift the turtle named Longneck to a friend and
Alain Reguera Delgado 46de3c
        you want to delete its section from the <quote>My Zoo</quote>
Alain Reguera Delgado 46de3c
        documentation manual. To do so, run the following command:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    <cmdsynopsis>
Alain Reguera Delgado 46de3c
    <command>centos-art help --delete --format="texinfo" "myzoo::turtles:longneck"</command>
Alain Reguera Delgado 46de3c
    </cmdsynopsis>
Alain Reguera Delgado 46de3c
<programlisting>
Alain Reguera Delgado 46de3c
Deleting        Documentation/Models/Texinfo/Myzoo/en_US/Turtles/longneck.texinfo
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.info.bz2
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.xhtml.tar.bz2
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.xml
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.docbook
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.pdf
Alain Reguera Delgado 46de3c
Updating        Documentation/Manuals/Texinfo/MyZoo/en_US/myzoo.txt.bz2
Alain Reguera Delgado 46de3c
</programlisting>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-bugs">
Alain Reguera Delgado 46de3c
    <title>Bugs</title>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        To report bugs related to this function, please create a new
Alain Reguera Delgado 46de3c
        ticket 
Alain Reguera Delgado 46de3c
        url="https://projects.centos.org/trac/artwork/newticket?summary=Error%20Standardizing%20Documentation%20Tasks&component=Scripts">here</ulink>
Alain Reguera Delgado 46de3c
        refering the specific problems you found in it. For example,
Alain Reguera Delgado 46de3c
        it would be useful if you copy and paste any error output from
Alain Reguera Delgado 46de3c
        <command>centos-art.sh</command> script.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-authors">
Alain Reguera Delgado 46de3c
    <title>Authors</title>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        The following people have worked in this functionality:
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    <itemizedlist>
Alain Reguera Delgado 46de3c
    <listitem>
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Alain Reguera Delgado <<ulink url="mailto:alain.reguera@gmail.com">alain.reguera@gmail.com</ulink>>, =COPYRIGHT_YEAR_LIST=
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </listitem>
Alain Reguera Delgado 46de3c
    </itemizedlist>
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <refsection id="scripts-bash-help-licence">
Alain Reguera Delgado 46de3c
    <title>License</title>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        Copyright © =COPYRIGHT_YEAR_LIST= =COPYRIGHT_HOLDER=
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
 
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        This program is free software; you can redistribute it and/or
Alain Reguera Delgado 46de3c
        modify it under the terms of the GNU General Public License as
Alain Reguera Delgado 46de3c
        published by the Free Software Foundation; either version 2 of
Alain Reguera Delgado 46de3c
        the License, or (at your option) any later version.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
 
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        This program is distributed in the hope that it will be
Alain Reguera Delgado 46de3c
        useful, but WITHOUT ANY WARRANTY; without even the implied
Alain Reguera Delgado 46de3c
        warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
Alain Reguera Delgado 46de3c
        PURPOSE.  See the GNU General Public License for more details.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
 
Alain Reguera Delgado 46de3c
    <para>
Alain Reguera Delgado 46de3c
        You should have received a copy of the GNU General Public
Alain Reguera Delgado 46de3c
        License along with this program; if not, write to the Free
Alain Reguera Delgado 46de3c
        Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
Alain Reguera Delgado 46de3c
        USA.
Alain Reguera Delgado 46de3c
    </para>
Alain Reguera Delgado 46de3c
    </refsection>
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
</refentry>