File: docbook-to-man.1

package info (click to toggle)
docbook-to-man 1%3A2.0.0-32
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,332 kB
  • ctags: 868
  • sloc: ansic: 5,819; sh: 1,371; makefile: 158
file content (141 lines) | stat: -rw-r--r-- 4,636 bytes parent folder | download | duplicates (6)
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
.\" $Header: /aolnet/dev/src/CVS/sgml/docbook-to-man/cmd/docbook-to-man.sh,v 1.1.1.1 1998/11/13 21:31:59 db3l Exp $
.\"
.\"	transcript compatibility for postscript use.
.\"
.\"	synopsis:  .P! <file.ps>
.\"
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t 
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n  
.TH "docbook-to-man" "1" 
.SH "NAME" 
docbook-to-man \(em convert \fBDocBook\fP       SGML into roff \-man macros 
.SH "SYNOPSIS" 
.PP 
\fBdocbook-to-man\fR [\fIsource.sgml\fR]  [>]  [\fIdestination.1\fR]  
.SH "DESCRIPTION" 
.PP 
The docbook-to-man tool is a batch converter that transforms 
UNIX-style manpages from the \fBDocBook\fP SGML       DTD into nroff/troff \-man macros. 
.PP 
docbook-to-man is the shell command that runs the low-level 
components to translate a single \fBDocBook\fP SGML document 
instance (whose document element is <RefEntry>) into 
pretty-much vanilla \-man macros, with tables rendered in 
tbl. 
.PP 
This is not the original version by Fred Dalrymple, but one 
with the ANS Modifications by David Bolen (db3l@ans.net). 
.PP 
This manual page and some small changes are by W. Borgert 
debacle@debian.org for \fBDebian GNU/Linux\fP.  Permission is 
granted to copy, distribute and/or modify this document under 
the terms of the GNU Free Documentation 
License, Version 1.1 or any later version published by the Free 
Software Foundation; with no Invariant Sections, no Front-Cover 
Texts and no Back-Cover Texts. 
.SH "White space and special characters" 
.PP 
If you want to use tabs in your manpage you should use <programlisting>, <literal> or <screen> and invoke docbook-to-man with INSTANT_OPT set to a tab character. Be aware that multiple tabs will be collapsed into one. 
.PP 
When you want to collapse white space into one, you should invoke docbook-to-man with INSTANT_OPT set to a space character. 
.PP 
Special characters like \\, ' or . will not be interpreted if you set INSTANT_OPT to a space or tab character. 
.SH "ENVIRONMENT" 
.PP 
If the variable INSTANT_OPT is not set, the 
\fBinstant(1)\fR is called with the parameter 
\fB\-d\fP by docbook-to-man.  If you don't want this, 
e.g. if you want to use some special characters literally in 
your SGML file, you can set INSTANT_OPT to just 
a space character:  
.PP 
\fBINSTANT_OPT=" 
" docbook-to-man src.sgml > 
dst.1\fR 
. 
.PP 
Note: The better way to use special characters like ^ or 
> is to write them in the SGML way, i.e. &caret; 
or &gt;. 
.SH "COPYRIGHT" 
.PP 
Copyright (c) 1996 X Consortium 
.PP 
Copyright (c) 1996 Dalrymple Consulting 
.PP 
Permission is hereby granted, free of charge, to any person 
obtaining a copy of this software and associated documentation 
files (the "Software"), to deal in the Software without 
restriction, including without limitation the rights to use, 
copy, modify, merge, publish, distribute, sublicense, and/or 
sell copies of the Software, and to permit persons to whom the 
Software is furnished to do so, subject to the following 
conditions: 
.PP 
The above copyright notice and this permission notice shall 
be included in all copies or substantial portions of the 
Software. 
.PP 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY 
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE 
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE 
AND NONINFRINGEMENT.  IN NO EVENT SHALL THE X CONSORTIUM OR 
DALRYMPLE CONSULTING BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE 
USE OR OTHER DEALINGS IN THE SOFTWARE. 
.PP 
Except as contained in this notice, the names of the X 
Consortium and Dalrymple Consulting shall not be used in 
advertising or otherwise to promote the sale, use or other 
dealings in this Software without prior written 
authorization. 
.SH "See also" 
.PP 
instant(1) and transpec(5) 
.\" created by instant / docbook-to-man, Fri 10 Sep 2004, 13:13