helpStandardize constructions tasks inside &TCAR;helpStandardize documentation tasks inside &TCAR;.centos-art help--help--quiet--answer-yes--sync-changes--format="KEYWORD"--search="KEYWORD"--edit--read--update-output--update-structure--copy--delete--renameMANUAL:PART:CHAPTER:SECTIONLOCATIONDescription
The help functionality exists to create
and maintain documentation manuals inside &TCAR;.
Documentation Entries
The documentation entry identifies the specific file you want
to work with inside a documentation manual. The help
functionality recognizes documentation entries in the
following formats:
Path style
This format uses paths to represent the documentation entries
you want to work with. This format assumes you are using the
first path component as chapter and the rest of the path as
section identifier both inside tcar-fs
documentation manual as parent documentation structure. The
field related to the part sectioning structure in the
documentation entry (the second field) is assumed empty, as
well. For example, if you want to document the directory
trunk/Scripts/Bash/Functions/Help,
then you can do it with the following command:
centos-art help --edit trunk/Scripts/Bash/Functions/HelpColon style
This format uses colons to represent the documentation entries
you want to work with. In this format, the whole documentation
entry is divided in fields using colon as separator character.
Documentation entries written this way use each field to
specify manual, part, chapter and section identifiers (in this
order). The section identifier can use a path style or hyphen
style to separate
components. For example, if you want to document the directory
trunk/Scripts/Bash/Functions/Help,
then you can do it with any of the following commands:
centos-art help --edit tcar-fs::trunk:Scripts/Bash/Functions/Helpcentos-art help --edit tcar-fs::trunk:scripts-bash-functions-help
The documentation manual name specified in the first field of
a colon style documentation entry, must match the name the
name of the directory where the documentation manual is stored
in. By default documentation manuals are written in
trunk/Documentation/Models/Texinfo or
trunk/Documentation/Models/Docbook directories, based on
whether they are written in Texinfo or Docbook documentation
format.
The match relation between the manual name you provide in the
documentation entry and the related directory name inside
&TCAR; is case insensitive. The same is true for all other
documentation entry fields.
From these documentation entry formats, the colon style
provides more flexibility than path style does. You can use
documentation entries written in colon style to create and
maintain different documentation manuals, including the
tcar-fs documentation manual. This is something
you cannot do with documentation entries written in path style
because they confine all documentation actions to
tcar-fs documentation manual.
Options
The centos-art help command accepts common
options described in and the following
specific options:
Assume yes to all confirmation requests.
Synchronizes available changes between the working copy and
the central repository.
Specifies the format of documentation entry source file. This
information is used as reference to build the absolute path of
documentation entry, so you always have to provide it in order
to reach the documentation entry you want to work with.
Possible values for this option are shown in in .