3 # Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015, 2016 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.
19 import xml.dom.minidom
28 %(argv0)s: XML to nroff converter
29 Converts the XML format supplied as input into an nroff-formatted manpage.
30 usage: %(argv0)s [OPTIONS] INPUT.XML [VAR=VALUE]...
31 where INPUT.XML is a manpage in an OVS-specific XML format.
33 Each VAR, when enclosed by "@"s in the input, is replaced by its
34 corresponding VALUE, with characters &<>"' in VALUE escaped.
36 The following options are also available:
37 -I, --include=DIR search DIR for include files (default: .)
38 --version=VERSION use VERSION to display on document footer
39 -h, --help display this help message\
40 """ % {'argv0': argv0}
44 def manpage_to_nroff(xml_file, subst, include_path, version=None):
45 with open(xml_file) as f:
47 for k, v in subst.iteritems():
48 content = content.replace(k, v)
49 doc = xml.dom.minidom.parseString(content).documentElement
51 xi_nodes = doc.getElementsByTagName("xi:include")
53 fn = node.getAttribute("href")
55 for dir in include_path:
57 with open("%s/%s" % (dir, fn)) as xi_f:
62 sys.stderr.write("%s: could not open include file %s\n"
65 for k, v in subst.iteritems():
66 content = content.replace(k, v)
67 xi_doc = xml.dom.minidom.parseString(content).documentElement
68 doc.replaceChild(xi_doc, node)
72 program = doc.attributes['program'].nodeValue
73 title = doc.attributes['title'].nodeValue
74 section = doc.attributes['section'].nodeValue
76 # Putting '\" p as the first line tells "man" that the manpage
77 # needs to be preprocessed by "pic".
80 .TH "%s" %s "%s" "Open vSwitch %s" "Open vSwitch Manual"
81 .fp 5 L CR \\" Make fixed-width font available as \\fL.
93 ''' % (build.nroff.text_to_nroff(program), build.nroff.text_to_nroff(section),
94 build.nroff.text_to_nroff(title), build.nroff.text_to_nroff(version))
96 s += build.nroff.block_xml_to_nroff(doc.childNodes) + "\n"
101 if __name__ == "__main__":
103 options, args = getopt.gnu_getopt(sys.argv[1:], 'hVI:',
104 ['version=', 'help', 'include='])
105 except getopt.GetoptError, geo:
106 sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
113 for key, value in options:
114 if key == '--version':
116 elif key in ['-h', '--help']:
118 elif key in ['-I', '--include']:
119 include_path.append(value)
126 sys.stderr.write("%s: exactly 1 non-option arguments required "
127 "(use --help for help)\n" % argv0)
132 var, value = s.split('=', 1)
133 value = value.replace('&', '&')
134 value = value.replace('<', '<')
135 value = value.replace('>', '>')
136 value = value.replace('"', '"')
137 value = value.replace("'", ''')
138 subst['@%s@' % var] = value
141 s = manpage_to_nroff(args[0], subst, include_path, version)
142 except build.nroff.error.Error, e:
143 sys.stderr.write("%s: %s\n" % (argv0, e.msg))
145 for line in s.splitlines():