docutils/test/functional/expected/standalone_rst_manpage.man

   1 .\" Man page generated from reStructuredText.
   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 rst2man.py inputfile outputfile
  39 .UNINDENT
  40 .UNINDENT
  41 .SH DESCRIPTION
  42 .sp
  43 rst2man transforms a reStructured text document into a unix man page.
  44 .sp
  45 In theory any valid reStructured text document should be processable,
  46 in reality this is
  47 .INDENT 0.0
  48 .IP \(bu 2
  49 a goal, that is not met yet
  50 .IP \(bu 2
  51 a goal that might never be met, because only few constructs are
  52 used in man pages \fIand\fP because the common text file does not adhere
  53 to man page requirements.
  54 .sp
  55 For example a unix man page belongs into a numbered section, 1 is
  56 user commands, 8 contains administrator commands and the headlines
  57 of all manpages are collected into a database, queryable with the
  58 programm \fBapropos\fP, therefore the headline should contain a short
  59 text describing into which group this command belongs.
  60 .sp
  61 These informations are collected from title, subtitle and the
  62 docinfo, see this document as an example.
  63 .UNINDENT
  64 .SH OPTIONS
  65 .INDENT 0.0
  66 .TP
  67 .BI \-\-config\fB= <file>
  68 Read configuration settings from <file>, if it exists.
  69 .TP
  70 .B \-\-version\fP,\fB  \-V
  71 Show this program\(aqs version number and exit.
  72 .TP
  73 .B \-\-help\fP,\fB  \-h
  74 Show this help message and exit.
  75 .UNINDENT
  76 .sp
  77 And a lot more standard docutils options.
  78 .SH FILES
  79 .sp
  80 None yet.
  81 .SH SEE ALSO
  82 .sp
  83 \fI\%docutils\fP
  84 \fI\%linux man page howto\fP
  85 .sp
  86 and \fBman man\fP also \fBman 7 man\fP
  87 .SH BUGS
  88 .INDENT 0.0
  89 .IP 1. 3
  90 Format options are included as they are required.
  91 .IP 2. 3
  92 bullet lists
  93 .IP 3. 3
  94 number lists
  95 .IP 4. 3
  96 math: The LaTeX source is shown, e.g. \fBn! + \esin(x_n^2)\fP\&.
  97 .UNINDENT
  98 .sp
  99 Discussion is still open.
 100 .SH AUTHOR
 101 grubert@users.sourceforge.net
 102 .SH COPYRIGHT
 103 public domain
 104 .\" Generated by docutils manpage writer.
 105 .