EnglishFrenchSpanish

OnWorks favicon

src2man - Online in the Cloud

Run src2man in OnWorks free hosting provider over Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator

This is the command src2man that can be run in the OnWorks free hosting provider using one of our multiple free online workstations such as Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator

PROGRAM:

NAME


src2man - extract man pages from source files.

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;
}

Use src2man online using onworks.net services


Free Servers & Workstations

Download Windows & Linux apps

  • 1
    Image Downloader
    Image Downloader
    Crawl and download images using
    Selenium Using python3 and PyQt5.
    Supported Search Engine: Google, Bing,
    Baidu. Keywords input from the keyboard
    or input from ...
    Download Image Downloader
  • 2
    Eclipse Tomcat Plugin
    Eclipse Tomcat Plugin
    The Eclipse Tomcat Plugin provides
    simple integration of a tomcat servlet
    container for the development of java
    web applications. You can join us for
    discussio...
    Download Eclipse Tomcat Plugin
  • 3
    WebTorrent Desktop
    WebTorrent Desktop
    WebTorrent Desktop is for streaming
    torrents on Mac, Windows or Linux. It
    connects to both BitTorrent and
    WebTorrent peers. Now there's no
    need to wait for...
    Download WebTorrent Desktop
  • 4
    GenX
    GenX
    GenX is a scientific program to refine
    x-ray refelcetivity, neutron
    reflectivity and surface x-ray
    diffraction data using the differential
    evolution algorithm....
    Download GenX
  • 5
    pspp4windows
    pspp4windows
    PSPP is a program for statistical
    analysis of sampled data. It is a free
    replacement for the proprietary program
    SPSS. PSPP has both text-based and
    graphical us...
    Download pspp4windows
  • 6
    Git Extensions
    Git Extensions
    Git Extensions is a standalone UI tool
    for managing Git repositories. It also
    integrates with Windows Explorer and
    Microsoft Visual Studio
    (2015/2017/2019). Th...
    Download Git Extensions
  • More »

Linux commands

Ad