analyze(1)

NAME
analyze - documentation system for various programming languages

DESCRIPTION
analyze is a documentation system for C++, C, Java, Objective-C, IDL (Corba and Microsoft flavors), Fortran, Python, VHDL and to some extent PHP, C#, and D.

You can use analyze in a number of ways:

1) Use analyze to generate a template configuration file*:

    analyze [-s] -g [configName]

2) Use analyze to update an old configuration file*:

    analyze [-s] -u [configName]

3) Use analyze to generate documentation using an existing configuration file*:

    analyze [configName]

4) Use analyze to generate a template file controlling the layout of the generated documentation:

    analyze -l [layoutFileName]

       In case layoutFileName is omitted analyzeLayout.xml will be used as filename.
       If - is used for layoutFileName analyze will write to standard output.

5) Use analyze to generate a template style sheet file for RTF, HTML or Latex.

    RTF: analyze -w rtf styleSheetFile

    HTML: analyze -w html headerFile footerFile styleSheetFile [configFile]

    LaTeX: analyze -w latex headerFile footerFile styleSheetFile [configFile]

6) Use analyze to generate an rtf extensions file

    RTF: analyze -e rtf extensionsFile

       If - is used for extensionsFile analyze will write to standard output.

7) Use analyze to compare the used configuration file with the template configuration file

    analyze -x [configFile]

Use analyze to compare the used configuration file with the template configuration file
       without replacing the environment variables or CMake type replacement variables

    analyze -x_noenv [configFile]

8) Use analyze to show a list of built-in emojis.

    analyze -f emoji outputFileName

       If - is used for outputFileName analyze will write to standard output.

    *) If -s is specified the comments of the configuration items in the config file will be omitted.
       If configName is omitted 'analzfile' will be used as a default.
       If - is used for configFile analyze will write / read the configuration to /from standard output / input.

If -q is used for a analyze documentation run, analyze will see this as if QUIET=YES has been set.

-v print version string, -V print extended version information

-h,-? prints usage help information

analyze -d prints additional usage flags for debugging purposes

AUTHOR
analyze version @VERSION@, Copyright Dimitri van Heesch 1997-@YEAR@

SEE ALSO
analzwizard(1).