contrib/groffer/roff2.man

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