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