contrib/groffer/roff2.1.man

   1 .TH roff2@ROFF2MODE@ @MAN1EXT@ "@MDATE@" "groff @VERSION@"
   2 .SH NAME
   3 roff2@ROFF2MODE@ \- transform roff code into @ROFF2MODE@ mode
   4 .
   5 .\" roff2@ROFF2MODE@.1 - man page for roff2@ROFF2MODE@ (section 1).
   6 .
   7 .\" Source file position: <groff_source_top>/contrib/groffer/roff2.man
   8 .\" Installed position:   $prefix/share/man/man1/roff2@ROFF2MODE@.1
   9 .
  10 .
  11 .\" ====================================================================
  12 .\" Legal Terms
  13 .\" ====================================================================
  14 .\"
  15 .\" Copyright (C) 2006-2018 Free Software Foundation, Inc.
  16 .\"
  17 .\" This file is part of groffer, which is part of GNU groff, a free
  18 .\" software project.
  19 .\"
  20 .\" You can redistribute it and/or modify it under the terms of the GNU
  21 .\" General Public License version 2 (GPL2) as published by the Free
  22 .\" Software Foundation.
  23 .\"
  24 .\" The license text is available in the internet at
  25 .\" <http://www.gnu.org/licenses/gpl-2.0.html>.
  26 .
  27 .
  28 .\" ====================================================================
  29 .\" Characters
  30 .\" ====================================================================
  31 .
  32 .\" Ellipsis ...
  33 .ie t .ds EL \fS\N'188'\fP\"
  34 .el .ds EL \&.\|.\|.\&\"
  35 .\" called with \*(EL
  36 .
  37 .
  38 .\" ====================================================================
  39 .SH "SYNOPSIS"
  40 .\" ====================================================================
  41 .
  42 .SY roff2@ROFF2MODE@
  43 .RI [ groffer-option
  44 \*(EL]
  45 .OP \-\-
  46 .RI [ filespec
  47 \*(EL]
  48 .YS
  49 .
  50 .SY roff2@ROFF2MODE@
  51 .B \-h
  52 .SY roff2@ROFF2MODE@
  53 .B \-\-help
  54 .YS
  55 .
  56 .SY roff2@ROFF2MODE@
  57 .B \-v
  58 .SY roff2@ROFF2MODE@
  59 .B \-\-version
  60 .YS
  61 .
  62 .P
  63 The options
  64 .B \-v
  65 and
  66 .B \%\-\-version
  67 print the version information of the program to standard output and exit.
  68 .
  69 The options
  70 .B \-h
  71 and
  72 .B \-\-help
  73 print a usage information of the program to standard output and stop
  74 the program instantly.
  75 .
  76 .
  77 .P
  78 All other options are assumed to be
  79 .B \%groffer
  80 options.
  81 .
  82 They are internally passed to
  83 .BR \%groffer .
  84 They override the behavior of the program.
  85 .
  86 The options are optional, they can be omitted.
  87 .
  88 .
  89 .P
  90 The
  91 .I \%filespec
  92 arguments correspond to the
  93 .I \%filespec
  94 arguments of
  95 .BR \%groffer .
  96 So they are either the names of existing, readable files or
  97 .B \-
  98 for standard input, or the name of a man page or a
  99 .BR \%groffer (@MAN1EXT@)
 100 man page search pattern.
 101 .
 102 If no
 103 .I \%filespec
 104 is specified standard input is assumed automatically.
 105 .
 106 .
 107 .\" ====================================================================
 108 .SH DESCRIPTION
 109 .
 110 .B \%roff2@ROFF2MODE@
 111 transforms
 112 .I roff
 113 code into
 114 .ie '@ROFF2MODE@'x' \{\
 115 .  I X
 116 mode corresponding to the
 117 .  I groff
 118 devices
 119 .  BR X *;
 120 this mode is suitable for
 121 .  BR \%gxditview (@MAN1EXT@).
 122 .\}
 123 .el \{\
 124 .  I \%@ROFF2MODE@
 125 mode.
 126 .\}
 127 .
 128 Print the result to standard output.
 129 .
 130 .
 131 .P
 132 There are more of these programs for generating other formats of
 133 .I \%roff
 134 input.
 135 .
 136 .if !'@ROFF2MODE@'dvi' \{\
 137 .  TP
 138 .  BR \%roff2dvi (@MAN1EXT@)
 139 is for
 140 .  I dvi
 141 mode.
 142 .\}
 143 .
 144 .if !'@ROFF2MODE@'html' \{\
 145 .  TP
 146 .  BR \%roff2html (@MAN1EXT@)
 147 generates
 148 .  I HTML
 149 output.
 150 .\}
 151 .
 152 .if !'@ROFF2MODE@'pdf' \{\
 153 .  TP
 154 .  BR \%roff2pdf (@MAN1EXT@)
 155 outputs
 156 .  I pdf
 157 mode.
 158 .\}
 159 .
 160 .if !'@ROFF2MODE@'ps' \{\
 161 .  TP
 162 .  BR \%roff2ps (@MAN1EXT@)
 163 prints
 164 .  I \%PostScript
 165 format to standard output.
 166 .\}
 167 .
 168 .if !'@ROFF2MODE@'text' \{\
 169 .  TP
 170 .  BR \%roff2text (@MAN1EXT@)
 171 generates text output in the
 172 .  B groff
 173 device
 174 .  IR latin1 .
 175 .\}
 176 .
 177 .if !'@ROFF2MODE@'x' \{\
 178 .  TP
 179 .  BR \%roff2x (@MAN1EXT@)
 180 prints the output in the
 181 .  B groff
 182 device
 183 .  B X
 184 that is suitable for programs like
 185 .  BR \%gxditview (@MAN1EXT@)
 186 or
 187 .  BR \%xditview (1).
 188 .\}
 189 .
 190 .
 191 .\" ====================================================================
 192 .SH AUTHORS
 193 .\" ====================================================================
 194 .B roff2@ROFF2MODE@
 195 was written by
 196 .MT groff\-bernd.warken\-72@\:web.de
 197 Bernd Warken
 198 .ME .
 199 .
 200 .
 201 .\" ====================================================================
 202 .SH "SEE ALSO"
 203 .\" ====================================================================
 204 .
 205 .BR \%groff (@MAN1EXT@),
 206 .BR \%groffer (@MAN1EXT@),
 207 .if !'@ROFF2MODE@'dvi' \
 208 .  BR \%roff2dvi (@MAN1EXT@),
 209 .if !'@ROFF2MODE@'html' \
 210 .  BR \%roff2html (@MAN1EXT@),
 211 .if !'@ROFF2MODE@'pdf' \
 212 .  BR \%roff2pdf (@MAN1EXT@),
 213 .if !'@ROFF2MODE@'ps' \
 214 .  BR \%roff2ps (@MAN1EXT@),
 215 .if !'@ROFF2MODE@'text' \
 216 .  BR \%roff2text (@MAN1EXT@),
 217 .if !'@ROFF2MODE@'x' \
 218 .  BR \%roff2x (@MAN1EXT@),
 219 .BR \%gxditview (@MAN1EXT@).
 220 .
 221 .
 222 .\" ====================================================================
 223 .\" Emacs settings
 224 .\" ====================================================================
 225 .
 226 .\" Local Variables:
 227 .\" mode: nroff
 228 .\" End:
 229 .\" vim: set filetype=groff: