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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
# Copyright 2005 Canonical Ltd.
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""man.py - create man page from built-in bzr help and static text
TODO:
* use usage information instead of simple "bzr foo" in COMMAND OVERVIEW
* add command aliases
"""
import os
import sys
import textwrap
import time
import bzrlib
import bzrlib.help
import bzrlib.commands
def get_filename(options):
"""Provides name of manpage"""
return "%s.1" % (options.bzr_name)
def infogen(options, outfile):
"""Assembles a man page"""
t = time.time()
tt = time.gmtime(t)
params = \
{ "bzrcmd": options.bzr_name,
"datestamp": time.strftime("%Y-%m-%d",tt),
"timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
"version": bzrlib.__version__,
}
outfile.write(man_preamble % params)
outfile.write(man_escape(man_head % params))
outfile.write(man_escape(getcommand_list(params)))
outfile.write(man_escape(getcommand_help(params)))
outfile.write(man_escape(man_foot % params))
def man_escape(string):
"""Escapes strings for man page compatibility"""
result = string.replace("\\","\\\\")
result = result.replace("`","\\`")
result = result.replace("'","\\'")
result = result.replace("-","\\-")
return result
def command_name_list():
"""Builds a list of command names from bzrlib"""
command_names = bzrlib.commands.builtin_command_names()
command_names.sort()
return command_names
def getcommand_list (params):
"""Builds summary help for command names in manpage format"""
bzrcmd = params["bzrcmd"]
output = '.SH "COMMAND OVERVIEW"\n'
for cmd_name in command_name_list():
cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
if cmd_object.hidden:
continue
cmd_help = cmd_object.help()
if cmd_help:
firstline = cmd_help.split('\n', 1)[0]
usage = bzrlib.help.command_usage(cmd_object)
tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
output = output + tmp
else:
raise RuntimeError, "Command '%s' has no help text" % (cmd_name)
return output
def getcommand_help(params):
"""Shows individual options for a bzr command"""
output='.SH "COMMAND REFERENCE"\n'
for cmd_name in command_name_list():
cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
if cmd_object.hidden:
continue
output = output + format_command(params, cmd_object)
return output
def format_command (params, cmd):
"""Provides long help for each public command"""
subsection_header = '.SS "%s"\n' % (bzrlib.help.command_usage(cmd))
doc = "%s\n" % (cmd.__doc__)
docsplit = cmd.__doc__.split('\n')
doc = '\n'.join([docsplit[0]] + [line[4:] for line in docsplit[1:]])
option_str = ""
options = cmd.options()
if options:
option_str = "\nOptions:\n"
for option_name, option in sorted(options.items()):
l = ' --' + option_name
if option.type is not None:
l += ' ' + option.argname.upper()
short_name = option.short_name()
if short_name:
assert len(short_name) == 1
l += ', -' + short_name
l += (30 - len(l)) * ' ' + option.help
# TODO: Split help over multiple lines with
# correct indenting and wrapping.
wrapped = textwrap.fill(l, initial_indent='',
subsequent_indent=30*' ')
option_str = option_str + wrapped + '\n'
return subsection_header + option_str + "\n" + doc + "\n"
man_preamble = """\
Man page for %(bzrcmd)s (bazaar-ng)
.\\\"
.\\\" Large parts of this file are autogenerated from the output of
.\\\" \"%(bzrcmd)s help commands\"
.\\\" \"%(bzrcmd)s help <cmd>\"
.\\\"
.\\\" Generation time: %(timestamp)s
.\\\"
"""
man_head = """\
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
.SH "NAME"
%(bzrcmd)s - bazaar-ng next-generation distributed version control
.SH "SYNOPSIS"
.B "%(bzrcmd)s"
.I "command"
[
.I "command_options"
]
.br
.B "%(bzrcmd)s"
.B "help"
.br
.B "%(bzrcmd)s"
.B "help"
.I "command"
.SH "DESCRIPTION"
bazaar-ng (or
.B "%(bzrcmd)s"
) 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.
"""
man_foot = """\
.SH "ENVIRONMENT"
.TP
.I "BZRPATH"
Path where
.B "%(bzrcmd)s"
is to look for external command.
.TP
.I "BZREMAIL"
E-Mail address of the user. Overrides default user config.
.TP
.I "EMAIL"
E-Mail address of the user. Overriddes default user config.
.SH "FILES"
.TP
.I "~/.bazaar/bazaar.conf/"
Contains the default user config. Only one section, [DEFAULT] is allowed. A
typical default config file may be similiar to:
.br
.br
.B [DEFAULT]
.br
.B email=John Doe <jdoe@isp.com>
.SH "SEE ALSO"
.UR http://www.bazaar-vcs.org/
.BR http://www.bazaar-vcs.org/
"""
|