File: docbook-to-man.sgml

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 (125 lines) | stat: -rw-r--r-- 5,426 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
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
  <!ENTITY debian  "<productname>Debian GNU/Linux</productname>">
  <!ENTITY docbook "<productname>DocBook</productname>">
  <!ENTITY sgml    "<abbrev>SGML</abbrev>">
]>

<!-- Manual page for docbook-to-man, DocBook source file
     (C) 1999 W. Borgert debacle@debian.org

     $Id: docbook-to-man.sgml,v 1.10 2003/08/17 19:35:54 debacle Exp $ -->

<refentry>
  <refentryinfo>
    <address>
      <email>debacle@debian.org</email>
    </address>
    <author>
      <firstname>W.</firstname>
      <surname>Borgert</surname>
    </author>
    <date>1999-06-03</date>
  </refentryinfo>
  <refmeta>
    <refentrytitle>docbook-to-man</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>docbook-to-man</refname> <refpurpose>convert &docbook;
      &sgml; into roff \-man macros</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>docbook-to-man</command>
      <arg><replaceable>source.sgml</replaceable></arg>
      <arg>&gt;</arg>
      <arg><replaceable>destination.1</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>The docbook-to-man tool is a batch converter that transforms
      UNIX-style manpages from the &docbook; &sgml;
      <abbrev>DTD</abbrev> into nroff/troff \-man macros.</para>

    <para>docbook-to-man is the shell command that runs the low-level
      components to translate a single &docbook; &sgml; document
      instance (whose document element is &lt;RefEntry&gt;) into
      pretty-much vanilla \-man macros, with tables rendered in
      tbl.</para>

    <para>This is not the original version by Fred Dalrymple, but one
      with the ANS Modifications by David Bolen (db3l@ans.net).</para>

    <para>This manual page and some small changes are by W. Borgert
      <email>debacle@debian.org</email> for &debian;.  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the <acronym>GNU</acronym> 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.</para>
  </refsect1>
  <refsect1>
    <title>White space and special characters</title>
      <para>If you want to use tabs in your manpage you should use &lt;programlisting&gt;, &lt;literal&gt; or &lt;screen&gt; and invoke docbook-to-man with <envar>INSTANT_OPT</envar> set to a tab character. Be aware that multiple tabs will be collapsed into one.</para>
      <para>When you want to collapse white space into one, you should invoke docbook-to-man with <envar>INSTANT_OPT</envar> set to a space character.</para>
      <para>Special characters like \\, ' or . will not be interpreted if you set <envar>INSTANT_OPT</envar> to a space or tab character.</para> 
  </refsect1>
  <refsect1>
    <title>ENVIRONMENT</title>
    <subtitle>INSTANT_OPT</subtitle>
    <para>If the variable <envar>INSTANT_OPT</envar> is not set, the
      <command>instant(1)</command> is called with the parameter
      <option>-d</option> 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 <envar>INSTANT_OPT</envar> to just
      a space character: <cmdsynopsis><command>INSTANT_OPT=&quot;
      &quot; docbook-to-man src.sgml &gt;
      dst.1</command></cmdsynopsis>.</para>

    <para>Note: The better way to use special characters like &caret; or
      &gt; is to write them in the &sgml; way, i.e. &amp;caret&semi;
      or &amp;gt&semi;.</para>
  </refsect1>
  <refsect1>
    <title>COPYRIGHT</title>

    <para>Copyright (c) 1996 X Consortium</para>
    <para>Copyright (c) 1996 Dalrymple Consulting</para>

    <para>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:</para>

    <para>The above copyright notice and this permission notice shall
      be included in all copies or substantial portions of the
      Software.</para>

    <para>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.</para>

    <para>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.</para>

  </refsect1>
  <refsect1>
    <title>See also</title>

    <para>instant(1) and transpec(5)</para>
  </refsect1>
</refentry>