MANOS(1)

NAME
manos - doxygen man page generator

SYNOPSIS
manos [--help]
manos [--version]
manos [--filter PATTERN] [--synopsis TYPE] [--section NUMBER] [--preamble FILE] [--epilogue FILE] [--topic TEXT] [--footer-middle TEXT] [--footer-inside TEXT] [--header-middle TEXT] [--autofill] [--output PATH] config
(See the OPTIONS section for details.)

DESCRIPTION
Generate man pages for a C project using Doxygen for documentation generation where config is the name of the Doxygen configuration file.

The Doxygen configuration file is generated by running doxygen(1) with the -g option followed by an optional file name. If the file name is omitted then Doxygen will name it Doxyfile. The contents of the file is a list of key/value pairs which need not be in any particular configuration for manos(1).

Doxygen already supports generating man pages via the GENERATE_MAN option, however, the output is less-than-stellar for projects written in the C programming language. For example the formatting and lack of per-function man page is atypical of what one would expect. Manos corrects these shortcomings by generating a man page per-function and with defacto standard formatting.

OPTIONS

-o path
--output path
    Where to write the generated man pages. Where path is a path to a directory on the file system. If the option is omitted, then the output is written to the same directory as the Doxygen configuration file. The user must have write permissions to the output directory.

-s number
--section number
    The man page section number. Must be an integer in the inclusive range 1-9. Defaults to 3.

--preamble file
    Content to prepend at the top of every generated man pages. Where file is the name of a file with the content.

--epilogue file
    Content to append to the bottom of every generated man pages. Where file is the name of a file with the content.

--topic text
    Text centered in the footer.

--footer-middle text
    Text centered at the bottom of the man page.

--footer-inside text
    Text at the bottom left of the man page.

--header-middle text
    Text centered in the header of the man page. This need not be supplied.

--autofill
    Populate header and footer text with auto-generated content. For example, the footer middle will be populated with the date the man page was generated.

-S type
--synopsis type
    Include type in the SYNOPSIS section of header file man pages. Where type is one of • functions
    • composites
    • enums
    • variables
    • typedefs
    • macros This option does not affect man pages for functions which implictly include the function signature that they document.

-F pattern
--filter pattern
    XML files matching pattern are excluded from processing.

-h
--help
    Display help text and exit. No other output is generated.

-v
--version
    Display version information and exit. No other output is generated.

RETURN CODES
manos returns code 0 on success, code 1 on an error, and code 2 if the program arguments are incorrect.

EXAMPLE
Assuming a C project has a Doxygen configuration file named Doxyfile, then run the following command from the same directory:

    $ manos Doxyfile

This command will generate man pages for the project. They will be written to the same directory as the Doxygen configuration file.

REPOSITORY
https://GitHub.com/hgs3/manos (https://GitHub.com/hgs3/manos)

LICENSE
Manos is distributed under an Open Source license. See the file "LICENSE" in the Manos source distribution for information on terms & conditions for accessing and otherwise using Manos and for a DISCLAIMER OF ALL WARRANTIES.