help — Standardize Documentation
Tasks
The help functionality is the interface
the centos-art.sh script provides to
control frequent documentation tasks (e.g., reading, editing,
update output files, etc.) requied by specific documentation
backends. Documentation backends supported by
help functionality are described in .
centos-art help [OPTIONS] [DIRECTORY]
The DIRECTORY parameter specifies the
directory path, inside the working copy of &TCAR;, where the
files you want to process the related documentation entry for.
This paramter can be provided more than once in order to
process more than one directory path in a single command
execution or not provided at all. When this parameter is not
provided, the current directory path where the command was
called from is used instead.
The help functionality accepts the
following options:
Supress all output messages except error messages. When this
option is passed, all confirmation requests are supressed and
a possitive answer is assumed for them, just as if the
option would have been provided.
Assume yes to all confirmation requests.
Supress all commit and update actions realized over files,
before and after the action itself had took place over files
in the working copy.
The NAME argument in this option specifies
what backend to use when processing documentation. Possible
arguments to this options are: texinfo or
docbook. If this option is not provided,
texinfo is used as default documentation
backend.
Go to node pointed by ID argument. When
texinfo backend is used, this arguments refers the node you
want to read documentation for. When docbook backend is used,
this argument refers the section id you want to read
documentation for.
Edit documentation entry related to path specified by
DIRECTORY parameter.
The DIRECTORY parameter must point to any
directory inside the working copy. When more than one
DIRECTORY are passed as non-option
arguments to the centos-art.sh script
command-line, they are queued for further edition. The
edition itself takes place through your default text editor
(e.g., the one you specified in the EDITOR
environment variable) and the text editor opens one file at
time (i.e., the queue of files to edit is not loaded in the
text editor.).
Read documentation entry specified by
DIRECTORY path. This option is used
internally by centos-art.sh script to print
out the reference you can follow to know more about an error
message.
Update output files rexporting them from the specified backend
source files.
Duplicate documentation entries inside the working copy.
When documentation entries are copied, it is required to pass
two non-option parameters in the command-line. The first
non-option parameter is considered the source location and the
second one the target location. Both source location and
target location must point to a directory under the working
copy.
Delete documentation entries specified by
DIRECTORY inside the working copy. It is
possible to delete more than one documentation entry by
specifying more DIRECTORY parameters in the
command-line.
Rename documentation entries inside the working copy.
When documentation entries are renamed, it is required to pass
only two non-option parameters to the command-line. The first
non-option parameter is considered the source location and the
second one the target location. Both source location and
target location must point to a directory under the working
copy.
When documentation entries are removed (e.g., through
or
options), the help functionality takes
care of updating nodes, menus and cross references related to
documentation entries in order to keep the manual structure in
a consistent state.