aeannotate - annotated source file listing Linux Man Page

NAME

aeannotate - annotated source file listing

SYNOPSIS

(n)

option ...

filename

(n)

-Help

(n)

-VERSion

DESCRIPTION

"(n)"

--column

l l l l.

-column;'${change date %Y-%m}';Date;7

-column;'$version';Version;9

-column;'${change developer}';Who;8

$version

aecp(1)

OPTIONS

-COLumn formula [ heading ][ width ]: This option may be used to specify columns you wish to see in the output. The formula is in the for of an aesub(5) string. The heading is a string to be used as the column heading; defaults to the formula if not specified. The width is the width of the columns; defaults to 7 if not specified.

-File_Statistics: This option causes file statistics to be appended. This lists the number of lines in the file were changed at the same time as another file. For example, this allows you to see tests associated with source files, and vice versa.

-Help: This option may be used to obtain more information about how to use the (n) program.

-Diff_Option string: This option may be used to pass addition arguments to the diff commands that is run between each delta of the file. Use with caution: poor choice of options can render aeannotate inoperable, or yield meaningless results. Probably the best use of this option is to pass the -b option, to ignore white space changes, because this ignores the vast majority of cosmetic formatting changes, showing you the content changes instead. The -i option, to ignore case, can also be useful for case-insensitive languages.

-Output filename: This option may be used to specify the output file. The output is sent to the standard output by default.

-Project name: This option may be used to select the project of interest. When no -Project option is specified, the AEGIS_PROJECT environment variable is consulted. If that does not exist, the user's $HOME/.aegisrc file is examined for a default project field (see aeuconf(5) for more information). If that does not exist, when the user is only working on changes within a single project, the project name defaults to that project. Otherwise, it is an error.

-Project

(n)

--

option

=

value

" convention is also understood.

EXIT STATUS

(n)

ENVIRONMENT VARIABLES

aegis(1)

EXAMPLES

l l l l.

-column;'${change date %Y}';Year;4

l l l l.

-column;'${change developer}';Develop.;8

-column;'${change reviewer}';Reviewer;8

l l l l.

-column;'$version';Version;9

-column;'${change cause}';Cause;20

aesub(5)

${change ...}

aeannotate -diff-opt -b filename

COPYRIGHT

(n) -VERSion License

AUTHOR

l r l.

Peter Miller;E-Mail:;millerp@canb.auug.org.au

/\/\*;WWW:;http://www.canb.auug.org.au/~millerp/