The help functionality
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 .
Synopsis
centos-art help [OPTIONS] path/to/dir …
The path/to/dir parameter specifies
the directory structure inside the working copy of The
CentOS Artwork Repository you want to process the related
documentation entry for. More than one directory structure
can be passed as path/to/dir
parameter.
The help functionality accepts the
following options:
Supress all output messages except error messages.
When this option is passed, all confirmation requests
are supressed as well and a possitive answer is
assumed for them, just as if the
option had 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.
Specify STRING as
default documentation backend to use. 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 index entry STRING.
Edit documentation entry related to path specified by
path/to/dir parameter.
The path/to/dir parameter must
point to any directory inside the repository. When
more than one path/to/dir 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
path/to/dir 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 of the repository.
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
path/to/dir inside the working
copy. It is possible to delete more than one
documentation entry by specifying more
path/to/dir 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 correct state.
Examples
centos-art help --edit trunk/Identity
This command edits the documentation entry related to
trunk/Identity
directory inside the repository working copy.
centos-art help --read trunk/Identity
This command reads the documentation entry related to
trunk/Identity
directory inside the repository working copy.
Author
Written by Alain Reguera Delgado.
Reporting bugs
Report bugs to centos-artwork@centos.org
mailing list.
Copyright
Copyright © 2009, 2010, 2011 The CentOS Artwork SIG.
This is free software. You may redistribute copies of it
under the terms of the .
There is NO WARRANTY, to the extent permitted by law.