GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SRC2MAN (1)

NAME

src2man - extract man pages from source files.

CONTENTS

Synopsis
Description
Options
Example
See Also
Author

SYNOPSIS



src2man [-n][-d date][-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 manpage, usually the function name, followed by a "-" and a short description. The following lines are the "DESCRIPTION" section content, except if they are in upper case, in which case they define a new section.

If the next line after a comment block is empty, Then no "SYNOPSIS" section will be generated. Otherwise, src2man will look in the following source lines for a function prototype or a type definion (struct, union, typedef, ...) matching the manpage name, and include it in a "SYNOPSIS" section. This avoids to duplicate the type or function 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 prototype. 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

-d date Set the date of the man pages. Defaults to current date.
-n No man page is created. The name of the manpages that would be created are printed.
-v volume Specify the name of the volume to be printed in center header of generated manpages.
-r release Specify the project name and release number for the generated manpage.

EXAMPLE

The following example displays C code and comments to generate a manpage 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@free.fr>
Search for    or go to Top of page |  Section 1 |  Main Index


txt2man-1.5.6 SRC2MAN (1) 03 April 2016

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.