File: cfdoc.8

package info (click to toggle)
cfengine2 2.2.10-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 10,184 kB
  • ctags: 5,650
  • sloc: ansic: 63,372; sh: 9,932; makefile: 218; lisp: 182; yacc: 100; perl: 72
file content (24 lines) | stat: -rw-r--r-- 819 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
.TH cfdoc 8 "2009-02-15"
.SH "NAME"
cfdoc \- Simple utility to document a cfengine configuration file
.SH "SYNOPSIS"
\&\fBcfdoc\fR
\&[\fB\-c\fR\ \fIcomment_marker\fR]
[\fB\-l\fR\ \fIlanguage\fR]
[\fB\-s\fR\ \fIstart-marker\fR]
[\fB\-e\fR\ \fIend-marker\fR]
<file
.SH "DESCRIPTION"
The purpose of \fBcfdoc\fR(8) is to document a cfengine configuration file 
(or other configuration file that uses '#' in the first line to indicate 
comments).
.SH "OPTIONS"
.IP "\fB\-c comment_marker\fR" 4
String indicating comment line (default is '#')
.IP "\fB\-l language\fR" 4
Markup language to use (default is LaTeX); known languages are "LaTeX", "HTML" and
"texinfo"
.IP "\fB\-s start_marker\fR" 4
Markup for start of code (default \\begin{verbatim})
.IP "\fB\-e end_marker\fR" 4
Markup for end of code (default \\end{verbatim})