cfdoc (8)

Simple utility to document a cfengine configuration file

  1. Carta.tech
  2. Man Pages
  3. System administration commands
  4. cfdoc: Simple utility to document a cfengine configuration file
  1. Carta.tech
  2. Packages
  3. cfengine2
  4. cfdoc: Simple utility to document a cfengine configuration file

SYNOPSIS

cfdoc [-c comment_marker] [-l language] [-s start-marker] [-e end-marker] <file

DESCRIPTION

The purpose of cfdoc(8) is to document a cfengine configuration file (or other configuration file that uses '#' in the first line to indicate comments).

OPTIONS

-c comment_marker

String indicating comment line (default is '#')

-l language

Markup language to use (default is LaTeX); known languages are "LaTeX", "HTML" and "texinfo"

-s start_marker

Markup for start of code (default \begin{verbatim})

-e end_marker

Markup for end of code (default \end{verbatim})