src2man

src2man(1)                                                          src2man(1)



NAME
       src2man - extract man pages from source files.

SYNOPSIS
       src2man [\fB-n][-v volume][-r release] [srcfile ...]

DESCRIPTION
       src2man  scans  source  file srcfile. Only C source files are supported
       for now. Comments blocks starting by "/** num", where num is a  section
       number, are converted into a man file, using txt2man(1).

       The  first  line of the comment block must contain the name of the man-
       page, usually the function name, followed by a "-" and a short descrip-
       tion.   The  following  lines  are  the  "DESCRIPTION" section content,
       except if they are in upper case, in which case they define a new  sec-
       tion.

       If  the next line after a comment block is a C function prototype, then
       a "SYNOPSIS" section will be filled using that prototype.  This  avoids
       to duplicate the prototype in the comment block.

       The  best place for code documentation is in the source file, where the
       body is implemented, not the header file which only contains the proto-
       type. src2man automatically searches for the presence of a prototype in
       the corresponding header file, and if found, will  print  a  "#include"
       statement in the synopsis.

OPTIONS
       \fB-n  No  man  page is created. The name of the manpages that would be
              created are printed.

       \fB-p volume
              Specify the name of the volume to be printed in center header of
              generated manpages.

       \fB-r release
              Specify  the  project  and release number for the generated man-
              page.

EXAMPLE
       The following example displays C code and comments to generate  a  man-
       page foobar.3:

            /** 3
             * foobar - a sample dummy function
             * This line is now the first of the description section.
             * Note that function parameters parm1 and parm2 are highlighted
             * in the generated man page.
             */
            int foobar(char *parm1, int parm2)
            {
               ...
               return 0;
            }


SEE ALSO
       txt2man(1), bookman(1).

AUTHOR
       Marc Vertes <mvertes AT free.fr>



txt2man-1.5.1                  October 27, 2006                     src2man(1)