DEMONSTRATION

Section: User Commands (1)
Updated: September 2013
Index Return to Main Contents

NAME

demonstration - demonstration of the example program

SYNOPSIS

This is a short (one-few) line synopsis of what the command does. As you see, it gets prepended to
the command's own help text, in the synopsis section.

DESCRIPTION

This is an example to demonstrate the use of help_to_man. It's really useful for a program to
print out detailed help with -h, especially because the program can adjust its help text to
the environment, and print out compile-time settings. Furthermore, if the documentation resides
within the program, it is more likely to be updated in sync with changes to the program.

However, man pages are still the most helpful and widely used format. The trick is to keep the two
in sync; this is what help_to_man does. So the documentation is dynamically constructed at build-time.

USAGE:    demonstration   OPTIONS

OPTIONS:  -h           show this help.

           -d           debug  (not actually implemented in this example).

           -a           print the ultimate answer (typically 42).

           -v           verbose

           -n  NUM      repeat NUM times.

           -x           Overwrite without confirmation.

RETURNS:
           0            on success.
           1            on error.

NOTES:    * This was compiled on Nov 21 2013
           * This is an example program, it doesn't actually do anything.

AUTHOR

The author of demonstration and this manual page is Richard Neill, <help_to_man#AT(spamblock)#richardneill.org>
Copyright September 2013; this is Free Software (GPL v3+), see the source for copying conditions.