3 # Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at:
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 from datetime import date
21 import xml.dom.minidom
23 from build.nroff import *
29 %(argv0)s: XML to nroff converter
30 Converts the XML format supplied as input into an nroff-formatted manpage.
31 usage: %(argv0)s [OPTIONS] INPUT.XML [VAR=VALUE]...
32 where INPUT.XML is a manpage in an OVS-specific XML format.
34 Each VAR, when enclosed by "@"s in the input, is replaced by its
35 corresponding VALUE, with characters &<>"' in VALUE escaped.
37 The following options are also available:
38 --version=VERSION use VERSION to display on document footer
39 -h, --help display this help message\
40 """ % {'argv0': argv0}
43 def manpage_to_nroff(xml_file, subst, version=None):
47 for k, v in subst.iteritems():
48 line = line.replace(k, v)
50 doc = xml.dom.minidom.parseString(''.join(input)).documentElement
51 d = date.fromtimestamp(os.stat(xml_file).st_mtime)
55 program = doc.attributes['program'].nodeValue
56 title = doc.attributes['title'].nodeValue
57 section = doc.attributes['section'].nodeValue
59 # Putting '\" p as the first line tells "man" that the manpage
60 # needs to be preprocessed by "pic".
63 .TH "%s" %s "%s" "Open vSwitch %s" "Open vSwitch Manual"
64 .fp 5 L CR \\" Make fixed-width font available as \\fL.
76 ''' % (text_to_nroff(program), text_to_nroff(section),
77 text_to_nroff(title), text_to_nroff(version))
79 s += block_xml_to_nroff(doc.childNodes) + "\n"
85 %(argv0)s: converts XML in a somewhat HTML-like format to nroff
86 usage: %(argv0)s [OPTIONS] XML
87 where XML is documentation in a somewhat HTML-like XML format.
88 The manpage, in nroff "man" format, is output on stdout.
90 The following options are also available:
91 --version=VERSION use VERSION to display on document footer
92 -h, --help display this help message\
93 """ % {'argv0': argv0}
96 if __name__ == "__main__":
98 options, args = getopt.gnu_getopt(sys.argv[1:], 'hV',
100 except getopt.GetoptError, geo:
101 sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
107 for key, value in options:
108 if key == '--version':
110 elif key in ['-h', '--help']:
116 sys.stderr.write("%s: exactly 1 non-option arguments required "
117 "(use --help for help)\n" % argv0)
122 var, value = s.split('=', 1)
123 value = value.replace('&', '&')
124 value = value.replace('<', '<')
125 value = value.replace('>', '>')
126 value = value.replace('"', '"')
127 value = value.replace("'", ''')
128 subst['@%s@' % var] = value
131 s = manpage_to_nroff(args[0], subst, version)
132 except error.Error, e:
133 sys.stderr.write("%s: %s\n" % (argv0, e.msg))
135 for line in s.splitlines():