test/functional/expected/standalone_rst_manpage.man

   1 .\" Man page generated from reStructeredText.
   2 .
   3 .TH RST2MAN 1 "2006-10-22" "0.1" "text processing"
   4 .SH NAME
   5 rst2man \- generate unix manpages from reStructured text
   6 .
   7 .nr rst2man-indent-level 0
   8 .
   9 .de1 rstReportMargin
  10 \\$1 \\n[an-margin]
  11 level \\n[rst2man-indent-level]
  12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13 -
  14 \\n[rst2man-indent0]
  15 \\n[rst2man-indent1]
  16 \\n[rst2man-indent2]
  17 ..
  18 .de1 INDENT
  19 .\" .rstReportMargin pre:
  20 . RS \\$1
  21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22 . nr rst2man-indent-level +1
  23 .\" .rstReportMargin post:
  24 ..
  25 .de UNINDENT
  26 . RE
  27 .\" indent \\n[an-margin]
  28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .nr rst2man-indent-level -1
  30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  32 ..
  33 .\" TODO: authors and author with name <email>
  34 .
  35 .SH SYNOPSIS
  36 .INDENT 0.0
  37 .INDENT 3.5
  38 .sp
  39 rst2man.py inputfile outputfile
  40 .UNINDENT
  41 .UNINDENT
  42 .SH DESCRIPTION
  43 .sp
  44 rst2man transforms a reStructured text document into a unix man page.
  45 .sp
  46 In theory any valid reStructured text document should be processable,
  47 in reality this is
  48 .INDENT 0.0
  49 .IP \(bu 2
  50 .
  51 a goal, that is not met yet
  52 .IP \(bu 2
  53 .
  54 a goal that might never be met, because only few constructs are
  55 used in man pages \fIand\fP because the common text file does not adhere
  56 to man page requirements.
  57 .sp
  58 For example a unix man page belongs into a numbered section, 1 is
  59 user commands, 8 contains administrator commands and the headlines
  60 of all manpages are collected into a database, queryable with the
  61 programm \fBapropos\fP, therefore the headline should contain a short
  62 text describing into which group this command belongs.
  63 .sp
  64 These informations are collected from title, subtitle and the
  65 docinfo, see this document as an example.
  66 .UNINDENT
  67 .SH OPTIONS
  68 .INDENT 0.0
  69 .TP
  70 .BI \-\-config\fB= <file>
  71 .
  72 Read configuration settings from <file>, if it exists.
  73 .TP
  74 .B \-\-version,  \-V
  75 .
  76 Show this program\(aqs version number and exit.
  77 .TP
  78 .B \-\-help,  \-h
  79 .
  80 Show this help message and exit.
  81 .UNINDENT
  82 .sp
  83 And a lot more standard docutils options.
  84 .SH FILES
  85 .sp
  86 None yet.
  87 .SH SEE ALSO
  88 .sp
  89 \fI\%docutils\fP
  90 \fI\%linux man page howto\fP
  91 .sp
  92 and \fBman man\fP also \fBman 7 man\fP
  93 .SH BUGS
  94 .INDENT 0.0
  95 .IP 1. 3
  96 .
  97 Format options are included as they are required.
  98 .IP 2. 3
  99 .
 100 bullet lists
 101 .IP 3. 3
 102 .
 103 number lists
 104 .IP 4. 3
 105 .
 106 math: The LaTeX source is shown, e.g. \fBn! + \esin(x_n^2)\fP.
 107 .UNINDENT
 108 .sp
 109 Discussion is still open.
 110 .SH AUTHOR
 111 grubert@users.sourceforge.net
 112 .SH COPYRIGHT
 113 public domain
 114 .\" Generated by docutils manpage writer.
 115 .\"
 116 .