3
# Copyright (C) 2005 by Hans Ulrich Niedermann
4
# Portions Copyright (C) 2005 by Canonical Ltd
6
# This program is free software; you can redistribute it and/or modify
7
# it under the terms of the GNU General Public License as published by
8
# the Free Software Foundation; either version 2 of the License, or
9
# (at your option) any later version.
11
# This program is distributed in the hope that it will be useful,
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
# GNU General Public License for more details.
16
# You should have received a copy of the GNU General Public License
17
# along with this program; if not, write to the Free Software
18
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
#<<< code taken from bzr (C) Canonical
25
version_info = sys.version_info
26
except AttributeError:
27
version_info = 1, 5 # 1.5 or older
30
REINVOKE = "__BZR_REINVOKE"
33
if version_info < NEED_VERS:
34
if not os.environ.has_key(REINVOKE):
35
# mutating os.environ doesn't work in old Pythons
36
os.putenv(REINVOKE, "1")
37
for python in 'python2.4', 'python2.3':
39
os.execvp(python, [python] + sys.argv)
42
print >>sys.stderr, "bzr-man.py: error: cannot find a suitable python interpreter"
43
print >>sys.stderr, " (need %d.%d or later)" % NEED_VERS
45
if hasattr(os, "unsetenv"):
48
import bzrlib, bzrlib.help
50
#>>> code taken from bzr (C) Canonical
58
def man_escape(string):
59
result = string.replace("\\","\\\\")
60
result = result.replace("`","\\`")
61
result = result.replace("'","\\'")
62
result = result.replace("-","\\-")
68
def parse_line(self, line):
72
class CommandListParser(Parser):
74
"""Parser for output of "bzr help commands".
76
The parsed content can then be used to
77
- write a "COMMAND OVERVIEW" section into a man page
78
- provide a list of all commands
81
def __init__(self,params):
83
self.command_usage = []
84
self.all_commands = []
85
self.usage_exp = re.compile("([a-z0-9-]+).*")
86
self.descr_exp = re.compile(" ([A-Z].*)\s*")
92
def parse_line(self, line):
93
m = self.usage_exp.match(line)
99
self.command_usage.append((self.command,self.usage,self.descr))
100
self.all_commands.append(self.command)
101
self.usage = " ".join(line.split(" ")[1:])
102
self.command = m.groups()[0]
104
raise RuntimeError, "matching usage line in state %d" % state
107
m = self.descr_exp.match(line)
110
self.descr = m.groups()[0]
112
raise RuntimeError, "matching descr line in state %d" % state
115
raise RuntimeError, "Cannot parse this line ('%s')." % line
120
self.command_usage.append((self.command,self.usage,self.descr))
121
self.all_commands.append(self.command)
123
raise RuntimeError, "ending parse in state %d" % state
125
def write_to_manpage(self, outfile):
126
bzrcmd = self.params["bzrcmd"]
127
outfile.write('.SH "COMMAND OVERVIEW"\n')
128
for (command,usage,descr) in self.command_usage:
129
outfile.write('.TP\n.B "%s %s"\n%s\n\n' % (bzrcmd, usage, descr))
134
def __init__(self, parser):
137
def write(self, data):
140
for line in data.split('\n'):
141
self.parser.parse_line(line)
144
def write_command_details(params, command, usage, descr, outfile):
145
x = ('.SS "%s %s"\n.B "%s"\n.PP\n.B "Usage:"\n%s %s\n\n' %
151
outfile.write(man_escape(x))
155
.\\\" Man page for %(bzrcmd)s (bazaar-ng)
157
.\\\" Large parts of this file are autogenerated from the output of
158
.\\\" \"%(bzrcmd)s help commands\"
159
.\\\" \"%(bzrcmd)s help <cmd>\"
161
.\\\" Generation time: %(timestamp)s
165
# The DESCRIPTION text was taken from http://www.bazaar-ng.org/
166
# and is thus (C) Canonical
168
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
170
%(bzrcmd)s - bazaar-ng next-generation distributed version control
187
) is a project of Canonical to develop an open source distributed version control system that is powerful, friendly, and scalable. Version control means a system that keeps track of previous revisions of software source code or similar information and helps people work on it in teams.
189
bazaar-ng is at an early stage of development, and the design is still changing from week to week. This man page here may be inconsistent with itself, with other documentation or with the code, and sometimes refer to features that are planned but not yet written. Comments are still very welcome; please send them to bazaar-ng@lists.canonical.com.
198
is to look for external command.
202
E-Mail address of the user. Overrides
203
.I "~/.bzr.conf/email" and
206
.I "John Doe <john@example.com>"
210
E-Mail address of the user. Overridden by the content of the file
211
.I "~/.bzr.conf/email"
212
and of the environment variable
218
Directory where all the user\'s settings are stored.
220
.I "~/.bzr.conf/email"
221
Stores name and email address of the user. Overrides content of
223
environment variable. Example content:
224
.I "John Doe <john@example.com>"
227
.UR http://www.bazaar-ng.org/
228
.BR http://www.bazaar-ng.org/,
229
.UR http://www.bazaar-ng.org/doc/
230
.BR http://www.bazaar-ng.org/doc/
238
"datestamp": time.strftime("%Y-%m-%d",tt),
239
"timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
240
"version": bzrlib.__version__,
243
clp = CommandListParser(params)
244
bzrlib.help.help("commands", outfile=HelpReader(clp))
248
if len(sys.argv) == 2:
249
filename = sys.argv[1]
253
outfile = open(filename,"w")
255
outfile.write(man_preamble % params)
256
outfile.write(man_escape(man_head % params))
257
clp.write_to_manpage(outfile)
260
# This doesn't do more than the summary so far.
261
#outfile.write('.SH "DETAILED COMMAND DESCRIPTION"\n')
262
#for (command,usage,descr) in clp.command_usage:
263
# write_command_details(params, command, usage, descr, outfile = outfile)
265
outfile.write(man_escape(man_foot % params))
268
if __name__ == '__main__':