summaryrefslogtreecommitdiff
path: root/doc/sbase/dist/birddoc
diff options
context:
space:
mode:
authorOndrej Zajicek (work) <santiago@crfreenet.org>2016-11-08 19:27:58 +0100
committerOndrej Zajicek (work) <santiago@crfreenet.org>2016-11-08 19:27:58 +0100
commit8860e991f6650e47cfe6c1af595fe4fe92a4edfd (patch)
tree18f49bb3a21739a1a596b54d9f65e82cff4fc09f /doc/sbase/dist/birddoc
parentcc5b93f72db80abd1262a0a5e1d8400ceef54385 (diff)
parentc8cafc8ebb5320ac7c6117c17e6460036f0fdf62 (diff)
Merge branch 'master' into int-new
Diffstat (limited to 'doc/sbase/dist/birddoc')
-rw-r--r--doc/sbase/dist/birddoc/groff/mapping144
-rw-r--r--doc/sbase/dist/birddoc/html/mapping72
-rw-r--r--doc/sbase/dist/birddoc/latex2e/mapping63
3 files changed, 145 insertions, 134 deletions
diff --git a/doc/sbase/dist/birddoc/groff/mapping b/doc/sbase/dist/birddoc/groff/mapping
index 71d2c935..3861a28d 100644
--- a/doc/sbase/dist/birddoc/groff/mapping
+++ b/doc/sbase/dist/birddoc/groff/mapping
@@ -6,7 +6,7 @@
% Based on qwertz replacement file by Tom Gordon
% linuxdoc mods by mdw
-% Groff dependencies are few. To port to another roff:
+% Groff dependencies are few. To port to another roff:
% 1. Check and modify, if necessary, font changes. (e.g. In psroff the
% same fonts have other names.)
% 2. Check the code for including Encapsulated PostScript, generated
@@ -19,13 +19,13 @@
% Hacked by mdw
".nr PI 3n\n"
- ".ds CF \\\\n\%\n"
+ ".ds CF \\\\n\%\n"
".ds CH \\&\n"
".ds dR $\n" % dollar, to avoid EQN conflicts
% Start with no TOC
".ds printtoc\n"
-
+
% Footnote style
".nr FF 1\n"
@@ -51,16 +51,16 @@
".nr HM 0i\n"
".nr FM 0i\n"
- % Turn off right-margin filling
+ % Turn off right-margin filling
".na\n"
-
+
% h is 1 if first paragraph after heading
- ".nr h 0\n"
+ ".nr h 0\n"
% initialize heading level
-
- ".nr il 1\n"
+
+ ".nr il 1\n"
% Number registers for list
@@ -68,20 +68,20 @@
".nr ll 0\n" % list level, stores current level
".nr el 0\n" % current enumeration level
- % Not all list levels are enumerations, as
+ % Not all list levels are enumerations, as
% itemizations can be embedded within enumerations
% and vice versa
-
+
% type of list level is in \n(t\n(ll, where
% 0 : itemize, 1 : enumerate, 2: description
% enumerator for an enumeration level is in
% \n(e\n(el -- i.e. \n(e1=2 means current item of
% enumeration level 1 is 2
-
+
% context-sensitive paragraph macro
-% Bug: There's some problem using this to re-start paragraphs after the
+% Bug: There's some problem using this to re-start paragraphs after the
% </verb> and </code>, so after verb and code I insert .LP. That's fine
% except that is loses indentation when using verb or code inside of a list.
@@ -95,21 +95,21 @@
% for this enumeration level
".if \\\\n(t\\\\n(ll=1 \\{.IP \\\\n+(e\\\\n(el.\\}\n"
% if first par element of descrip, do nothing
-".\\}\n"
+".\\}\n"
".el .sp \n" % subsequent par element of item
".\\}\n"
".el \\{\\\n" % not within list
-".ie \\\\nh=1 \\{\\\n" % first par after heading
-".LP\n"
+".ie \\\\nh=1 \\{\\\n" % first par after heading
+".LP\n"
".nr h 0\n" % reset h flag
-".\\}\n"
+".\\}\n"
".el .LP \n" % Changed from .PP, mdw
".\\}\n"
".nh\n"
-"..\n"
+"..\n"
+
+
-
-
% for each level, a number register is created
% to store its type and current item number, where
% -1=bullet of an itemized list.
@@ -141,7 +141,7 @@
% set initial level of headings, in register il
<article> + ".nr il 0" +
-</article> + ".if '\\*[printtoc]'true' .PX\n"
+</article> + ".if '\\*[printtoc]'true' .PX\n"
<report> + ".nr il 1" +
</report> + ".bp\n"
@@ -153,23 +153,23 @@
".bp\n"
".TC" +
-<notes>
+<notes>
</notes>
<manpage> + ".nr il -1" +
-</manpage>
+</manpage>
<progdoc>
</progdoc>
% Hacked up titlepag stuff to look more reasonable. Titles and author
% names are now stored in strings, printed by the end of </titlepag>.
-% Wake up! This uses groff-like long string names. You must use groff
+% Wake up! This uses groff-like long string names. You must use groff
% to format this.
<titlepag> + ".ds mdwtitle\n"
".ds mdwsubtitle\n"
- ".ds mdwdate\n"
+ ".ds mdwdate\n"
".de printabstract\n"
"..\n" +
</titlepag> + "\\*[mdwtitle]\n"
@@ -181,10 +181,10 @@
"\\*[mdwdate]\n"
".br\n"
".printabstract\n"
- ".br\n"
+ ".br\n"
%<title> + ".TL" +
-%</title>
+%</title>
<title> + ".ds mdwtitle "
</title> +
@@ -194,13 +194,13 @@
% ".SM" +
%</subtitle> + ".LG" +
-<subtitle> + ".ds mdwsubtitle "
+<subtitle> + ".ds mdwsubtitle "
</subtitle> +
-<date> + ".ds mdwdate "
+<date> + ".ds mdwdate "
</date> +
-<abstract> + ".de printabstract\n"
+<abstract> + ".de printabstract\n"
".LP\n"
</abstract> + ".." +
@@ -215,10 +215,10 @@
<name> + ".br" +
</name>
-<and>
+<and>
</and>
-<thanks> "\\**\n"
+<thanks> "\\**\n"
".FS" +
</thanks> + ".FE" +
@@ -229,11 +229,11 @@
<newline> + ".br"
</newline>
-<label>
-</label>
+<label>
+</label>
-<header>
-</header>
+<header>
+</header>
<lhead> + ".EH '"
</lhead> "'''" +
@@ -263,13 +263,13 @@
<toc>
</toc>
-<lof>
+<lof>
</lof>
-<lot>
+<lot>
</lot>
-<chapt> + ".bp\n"
+<chapt> + ".bp\n"
".NH \\n(il " +
</chapt>
@@ -283,7 +283,7 @@
</sect2>
<sect3> + ".NH 4+\\n(il" +
-</sect3>
+</sect3>
<sect4> + ".NH 5+\\n(il" +
</sect4>
@@ -292,10 +292,10 @@
</heading> + "\\*h\n"
".XS \\n%\n"
"\\*(SN \\*h\n"
- ".XE\n"
+ ".XE\n"
".nr h 1\n" % set heading flag to true
-<p> + ".Pp" +
+<p> + ".Pp" +
</p>
<itemize> + ".nr ll +1\n" % increment list level
@@ -309,9 +309,9 @@
".af e\\n(el \\*(f\\n(el\n" % style of enumerator
".if \\n(ll>1 .RS" +
</enum> + ".if \\n(ll>1 .RE\n"
- ".br\n"
+ ".br\n"
".nr el -1\n" % decrement enumeration level
- ".nr ll -1\n" % decrement list level
+ ".nr ll -1\n" % decrement list level
<descrip> + ".RS\n"
".nr ll +1\n" % increment list level
@@ -324,7 +324,7 @@
% If bi=1 then the paragraph is the first one of the item.
<item> + ".nr bi 1\n.Pp" +
-</item>
+</item>
<tag> + ".IP \"\\fB"
</tag> "\\fR\"\n"
@@ -337,12 +337,12 @@
</cf> ""
<cite> + ".\[\n[ID]\n.\]" +
-</cite>
+</cite>
<ncite> + ".\[\n[ID]\n.\]\n([NOTE])"
</ncite>
-<footnote> " (-- "
+<footnote> " (-- "
</footnote> "--)" +
<sq> "\\*Q"
@@ -353,20 +353,20 @@
</lq> + ".nr LL \\n(LL+\\n(PI\n"
".RE" +
-<em> "\\fI"
-</em> "\\fP"
+<em> "\\fI"
+</em> "\\fP"
-<bf> "\\fB"
-</bf> "\\fR"
+<bf> "\\fB"
+</bf> "\\fR"
-<it> "\\fI"
-</it> "\\fR"
+<it> "\\fI"
+</it> "\\fR"
-<sf> "\\fR"
-</sf> "\\fR"
+<sf> "\\fR"
+</sf> "\\fR"
-<sl> "\\fI"
-</sl> "\\fR"
+<sl> "\\fI"
+</sl> "\\fR"
% Changed by mdw
<tt> "\\fC"
@@ -394,10 +394,10 @@
<pageref> "??"
</pageref>
-<x>
+<x>
</x>
-<mc>
+<mc>
</mc>
<biblio> + ".\[\n"
@@ -423,7 +423,7 @@
% ".Pp" + % continue previous paragraph (changed mdw)
".LP"
-% tscreen added by mdw
+% tscreen added by mdw
<tscreen> + ".br\n"
".po 0.75i\n"
".ll 6.0i\n"
@@ -487,8 +487,8 @@
% mathematics -- this nroff version needs work.
-<f>
-</f>
+<f>
+</f>
<dm> + ".DS L" +
</dm> + ".DE" +
@@ -496,8 +496,8 @@
<eq> + ".DS L" +
</eq> + ".DE" +
-<fr>
-</fr>
+<fr>
+</fr>
<nu> "{"
</nu> "} over "
@@ -505,7 +505,7 @@
<de> "{"
</de> "}"
-<lim>
+<lim>
</lim>
<op>
@@ -527,7 +527,7 @@
</in>
<sum> " sum "
-</sum>
+</sum>
% limitation: eqn only does square roots!
@@ -539,7 +539,7 @@
"[ca]." +
</ar> + ".TE" +
-<arr> "\n"
+<arr> "\n"
</arr>
<arc> "|"
@@ -567,8 +567,8 @@
% limitation: no calligraphic characters, using helvetica italics instead. Is there a better font?
-<fi> "\\fI"
-</fi> "\\fP"
+<fi> "\\fI"
+</fi> "\\fP"
<phr> " roman }"
</phr> "}"
@@ -584,12 +584,12 @@
<eps> + ".if t .PSPIC [file].ps\n"
".if n .sp 4" +
-</eps>
-
+</eps>
+
% Are TeX units properly handled by this translation of ph?
<ph> + ".sp [VSPACE]" +
-</ph>
+</ph>
<caption> + ".sp\n.ce" +
</caption>
@@ -619,7 +619,7 @@
<slides> + ".nr PS 18" +
</slides>
-<slide>
+<slide>
</slide> + ".bp\n\\&" +
% letters -- replacement for email, using mh format.
diff --git a/doc/sbase/dist/birddoc/html/mapping b/doc/sbase/dist/birddoc/html/mapping
index 353d7774..1f05070c 100644
--- a/doc/sbase/dist/birddoc/html/mapping
+++ b/doc/sbase/dist/birddoc/html/mapping
@@ -21,7 +21,7 @@
</notes> + "<@@enddoc>" +
% Manual Pages are expected to be formatted using nroff (or groff), unless
-% they are included as sections of other qwertz documents.
+% they are included as sections of other qwertz documents.
<manpage>
</manpage>
@@ -35,7 +35,7 @@
<title> + "<@@title>"
</title>
-<subtitle> + "<H2>"
+<subtitle> + "<H2>"
</subtitle> "</H2>" +
<author>
@@ -48,26 +48,27 @@
</and>
<thanks> + "Thanks "
-</thanks>
+</thanks>
<inst> + "<H3>"
</inst> "</H3>" +
<newline> "<BR>"
-
+
<label> + "<@@label>[ID]" +
-
-<header>
-</header>
+</label>
+
+<header>
+</header>
<lhead> + "<!-- "
-</lhead> " -->" +
+</lhead> " -->" +
<rhead> + "<!-- "
</rhead> " -->" +
<comment> + "<H4>Comment</H4>" +
-</comment>
+</comment>
<abstract> + "<P><HR>\n<EM>"
</abstract> "</EM>\n<HR>" +
@@ -99,7 +100,7 @@
<sect3> + "<@@head>"
</sect3>
-<sect4> + "<@@head>"
+<sect4> + "<@@head>"
</sect4>
<heading>
@@ -134,6 +135,9 @@
<ncite> "[<I>[NOTE] ([ID])</I>]"
</ncite>
+<file> "<CODE>"
+</file> "</CODE>"
+
<footnote> + "<BLOCKQUOTE>"
</footnote> "</BLOCKQUOTE>" +
@@ -198,12 +202,14 @@
"<@@endurl>" +
</url>
-<htmlurl> + "<@@url>[URL]\n"
- "[NAME]</A>\n"
- "<@@endurl>" +
+<htmlurl> "<A HREF=\"[URL]\">[NAME]</A>"
</htmlurl>
-% ref modified to have an optional name field
+<rfc> "<A HREF=\"http://www.rfc-editor.org/info/rfc[ID]\">RFC [ID]</A>"
+</rfc>
+
+
+% ref modified to have an optional name field
<ref> + "<@@ref>[ID]\n"
"[NAME]</A>\n"
"<@@endref>" +
@@ -228,7 +234,7 @@
</mc> "</MC>"
<biblio> + "<BIBLIO STYLE=\"[STYLE]\" FILES=\"[FILES]\">" +
-</biblio>
+</biblio>
<code> + "<HR>\n<PRE>" +
</code> + "</PRE>\n<HR>" +
@@ -244,28 +250,28 @@
% theorems and such
-<def> + "<DEF>"
+<def> + "<DEF>"
</def> + "</DEF>" +
-<prop> + "<PROP>"
+<prop> + "<PROP>"
</prop> + "</PROP>" +
-<lemma> + "<LEMMA>"
+<lemma> + "<LEMMA>"
</lemma> + "</LEMMA>" +
-<coroll> + "<COROLL>"
+<coroll> + "<COROLL>"
</coroll> + "</COROLL>" +
-<proof> + "<PROOF>"
+<proof> + "<PROOF>"
</proof> + "</PROOF>" +
-<theorem> + "<THEOREM>"
+<theorem> + "<THEOREM>"
</theorem> + "</THEOREM>" +
<thtag> "<THTAG>"
</thtag> "</THTAG>"
-% mathematics
+% mathematics
<f>
</f>
@@ -315,11 +321,11 @@
<ar> "<AR>"
</ar> "</AR>"
-<arr> "<ARR>"
-</arr>
+<arr> "<ARR>"
+</arr>
<arc> "<ARC>"
-</arc>
+</arc>
<sup> "<SUP>"
</sup> "</SUP>"
@@ -354,13 +360,13 @@
</figure> + "</FIGURE>" +
<eps> + "<EPS FILE=\"[FILE]\">" +
-</eps>
-
+</eps>
+
<img> + "<IMG SRC=\"[SRC]\">" +
</img>
<ph> + "<PH VSPACE=\"[VSPACE]\">" +
-</ph>
+</ph>
<caption> + "<CAPTION>"
</caption> "</CAPTION>" +
@@ -403,7 +409,7 @@
</opening> "</OPENING>" +
-<from> + "<FROM>"
+<from> + "<FROM>"
</from> + "</FROM>" +
@@ -419,7 +425,7 @@
<email> + "<EMAIL>"
</email> "</EMAIL>" +
-<phone> + "<PHONE>"
+<phone> + "<PHONE>"
</phone> "</PHONE>" +
@@ -430,16 +436,16 @@
</subject> "</SUBJECT>" +
-<sref> + "<SREF>"
+<sref> + "<SREF>"
</sref> "</SREF>" +
-<rref> + "<RREF>"
+<rref> + "<RREF>"
</rref> "</RREF>" +
<rdate> + "<RDATE>"
</rdate> "</RDATE>" +
-<closing> + "<CLOSING>"
+<closing> + "<CLOSING>"
</closing> "</CLOSING>" +
<cc> + "<CC>"
diff --git a/doc/sbase/dist/birddoc/latex2e/mapping b/doc/sbase/dist/birddoc/latex2e/mapping
index 747d0d33..f53bbbe4 100644
--- a/doc/sbase/dist/birddoc/latex2e/mapping
+++ b/doc/sbase/dist/birddoc/latex2e/mapping
@@ -2,7 +2,9 @@
% birddoc to LaTeX replacement file
% The \relax is there to avoid sgml2latex rewriting the class
-<book> + "\\relax\\documentclass\[a4paper,10pt,openany\]{book}\n"
+<book> + "\\relax\\documentclass\[a4paper,10pt,openany,oneside\]{book}\n"
+ "\\usepackage\[colorlinks=true,linkcolor=blue,pdftitle={BIRD User's Guide}\]{hyperref}\n"
+ "\\usepackage{enumitem}\n"
"\\usepackage{birddoc}\n"
"\\usepackage{qwertz}\n"
"\\usepackage{url}\n"
@@ -14,7 +16,7 @@
</book> + "\\end{document}" +
% Manual Pages are expected to be formatted using nroff (or groff), unless
-% they are included as sections of other qwertz documents.
+% they are included as sections of other qwertz documents.
<manpage>
</manpage>
@@ -26,17 +28,17 @@
</titlepag> + "\n\n\\begin{document}\n"
"\\maketitle\n" +
-<title> + "\\title{"
+<title> + "\\title{"
</title> "}" +
<subtitle> "\\\\\n"
"{\\large "
</subtitle> "}" +
-<author> + "\\author{"
+<author> + "\\author{"
</author> "}" +
-<name>
+<name>
</name>
<and> "\\and " +
@@ -51,14 +53,14 @@
<date> + "\\date{"
</date> "}" +
-<newline> "\\\\ "
+<newline> "\\\\ "
</newline>
<label> "\\label{[ID]}"
-</label>
+</label>
<header> + "\\markboth"
-</header>
+</header>
<lhead> "{"
</lhead> "}"
@@ -73,7 +75,7 @@
</comment> "}"
% Hacked by mdw to use linuxdoc-sgml \abstract{...}
-<abstract> + "\\abstract{"
+<abstract> + "\\abstract{"
</abstract> "}" +
<appendix> + "\n \\appendix \n" +
@@ -101,15 +103,15 @@
</sect2>
<sect3> + "\n\\paragraph"
-</sect3>
+</sect3>
<sect4> + "\n\\subparagraph"
</sect4>
<heading> "{"
-</heading> "}\n\n"
+</heading> "}\n\n"
-<p>
+<p> "\\phantomsection{}"
</p> "\n\n"
<itemize> + "\\begin{itemize}" +
@@ -121,13 +123,13 @@
<list> + "\\begin{list}{}{}\n" +
</list> + "\\end{list}" +
-<descrip> + "\\begin{description}" +
+<descrip> + "\\begin{description}\[style=unboxed\]" +
</descrip> + "\\end{description}" +
<item> + "\\item "
</item>
-<tag> + "\\item\[{\\ttfamily "
+<tag> + "\\phantomsection\\item\[{\\ttfamily "
</tag> "}\] \\hfil\\break\n" +
<tagp> + "\\item\[ "
@@ -154,7 +156,7 @@
% The idea here is to automatically insert soft hyphens after every slash in
% the filename, so long filenames will break naturally. The url{} macro is
% a kluge but it works,
-<file> "\\url{"
+<file> "{\\tt "
</file> "}"
<footnote> "\\footnote{"
@@ -223,29 +225,32 @@
<cparam> "\\cparam{"
</cparam> "}"
-<ref> "\\ref{[ID]} {([NAME])}"
+<ref> "\\hyperref\[[ID]\]{[NAME]} (p.\\,\\getpagerefnumber{[ID]})"
</ref>
<pageref> "\\pageref{[ID]}"
</pageref>
%url added by HG
-<url> "\\nameurl{[URL]}{[NAME]}"
+<url> "\\href{[URL]}{[NAME]}"
</url>
-<htmlurl> "\\onlynameurl{[NAME]}"
+<htmlurl> "\\href{[URL]}{[NAME]}"
</htmlurl>
-<x>
+<rfc> "\\href{http://www.rfc-editor.org/info/rfc[ID]}{RFC [ID]}"
+</rfc>
+
+<x>
</x>
-<mc>
+<mc>
</mc>
<biblio> + "\\bibliographystyle{[STYLE]}\n"
"\\bibliography{[FILES]}\n"
"\\addbibtoc{}" +
-</biblio>
+</biblio>
% <macro> + "\\macro{[ID]}{\\qw[ID]}"
% </macro>
@@ -300,19 +305,19 @@
<thtag> "\["
</thtag> "\]" +
-% mathematics
+% mathematics
<f> "$"
</f> "$"
-<dm> + "\\\["
+<dm> + "\\\["
</dm> "\\\]" +
<eq> + "\\begin{equation}" +
</eq> + "\\end{equation}\n" +
<fr> "\\frac"
-</fr>
+</fr>
<nu> "{"
</nu> "}"
@@ -320,7 +325,7 @@
<de> "{"
</de> "}"
-<lim>
+<lim>
</lim>
<op>
@@ -342,7 +347,7 @@
</in>
<sum> "\\sum"
-</sum>
+</sum>
<root> "\\sqrt\[[n]\]{"
</root> "}"
@@ -390,11 +395,11 @@
</figure> + "\\end{figure}\n" +
<eps> + "\\centerline{\\epsfig{file=[FILE],height=[HEIGHT],angle=[ANGLE]}}" +
-</eps>
-
+</eps>
+
<ph> + "\\vspace{[VSPACE]}\n\\par" +
-</ph>
+</ph>
<caption> + "\\caption{"
</caption> "}" +