File: src2man.1

package info (click to toggle)
txt2man 1.6.0-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 272 kB
  • sloc: sh: 1,411; makefile: 37
file content (85 lines) | stat: -rw-r--r-- 2,570 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
.\" Text automatically generated by txt2man
.TH src2man 1 "15 August 2016" "txt2man-1.6.0" ""
.SH NAME
\fBsrc2man \fP- extract man pages from source files.
.SH SYNOPSIS
.nf
.fam C
\fBsrc2man\fP [\fB-n\fP][\fB-d\fP date][\fB-v\fP volume][\fB-r\fP \fIrelease\fP] [\fIsrcfile\fP \.\.\.]
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBsrc2man\fP scans source file \fIsrcfile\fP. 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 \fBtxt2man\fP(1).
.PP
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.
.PP
If the next line after a comment block is empty, Then no "SYNOPSIS"
section will be generated. Otherwise, \fBsrc2man\fP 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.
.PP
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. \fBsrc2man\fP automatically searches for the presence of a
prototype in the corresponding header file, and if found, will print a
"#include" statement in the synopsis.
.SH OPTIONS
.TP
.B
\fB-d\fP date
Set the date of the man pages. Defaults to current date.
.TP
.B
\fB-n\fP
No man page is created. The name of the manpages that would
be created are printed.
.TP
.B
\fB-v\fP volume
Specify the name of the volume to be printed in center header
of generated manpages.
.TP
.B
\fB-r\fP \fIrelease\fP
Specify the project name and \fIrelease\fP number for the generated
manpage.
.SH ENVIRONMENT
.TP
.B
SOURCE_DATE_EPOCH
Unix timestamp that is used for date in header instead
of current date.
.SH EXAMPLE
The following example displays C code and comments to generate a manpage
foobar.3:
.PP
.nf
.fam C
     /** 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;
     }

.fam T
.fi
.SH SEE ALSO
\fBtxt2man\fP(1), \fBbookman\fP(1).
.SH AUTHOR
Marc Vertes <mvertes@free.fr>