1
# Copyright 2005 Canonical Ltd.
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""man.py - create man page from built-in bzr help and static text
20
* use usage information instead of simple "bzr foo" in COMMAND OVERVIEW
31
import bzrlib.commands
34
def get_filename(options):
35
"""Provides name of manpage"""
36
return "%s.1" % (options.bzr_name)
39
def infogen(options, outfile):
40
"""Assembles a man page"""
44
{ "bzrcmd": options.bzr_name,
45
"datestamp": time.strftime("%Y-%m-%d",tt),
46
"timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
47
"version": bzrlib.__version__,
49
outfile.write(man_preamble % params)
50
outfile.write(man_escape(man_head % params))
51
outfile.write(man_escape(getcommand_list(params)))
52
outfile.write(man_escape(getcommand_help(params)))
53
outfile.write(man_escape(man_foot % params))
56
def man_escape(string):
57
"""Escapes strings for man page compatibility"""
58
result = string.replace("\\","\\\\")
59
result = result.replace("`","\\`")
60
result = result.replace("'","\\'")
61
result = result.replace("-","\\-")
65
def command_name_list():
66
"""Builds a list of command names from bzrlib"""
67
command_names = bzrlib.commands.builtin_command_names()
72
def getcommand_list (params):
73
"""Builds summary help for command names in manpage format"""
74
bzrcmd = params["bzrcmd"]
75
output = '.SH "COMMAND OVERVIEW"\n'
76
for cmd_name in command_name_list():
77
cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
80
cmd_help = cmd_object.help()
82
firstline = cmd_help.split('\n', 1)[0]
83
usage = cmd_object._usage()
84
tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
87
raise RuntimeError, "Command '%s' has no help text" % (cmd_name)
91
def getcommand_help(params):
92
"""Shows individual options for a bzr command"""
93
output='.SH "COMMAND REFERENCE"\n'
94
for cmd_name in command_name_list():
95
cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
98
output = output + format_command(params, cmd_object)
102
def format_command (params, cmd):
103
"""Provides long help for each public command"""
104
subsection_header = '.SS "%s"\n' % (cmd._usage())
105
doc = "%s\n" % (cmd.__doc__)
109
options = cmd.options()
111
option_str = "\nOptions:\n"
112
for option_name, option in sorted(options.items()):
113
for name, short_name, argname, help in option.iter_switches():
115
if argname is not None:
118
assert len(short_name) == 1
119
l += ', -' + short_name
120
l += (30 - len(l)) * ' ' + (help or '')
121
wrapped = textwrap.fill(l, initial_indent='',
122
subsequent_indent=30*' ')
123
option_str = option_str + wrapped + '\n'
127
if len(cmd.aliases) > 1:
128
aliases_str += '\nAliases: '
130
aliases_str += '\nAlias: '
131
aliases_str += ', '.join(cmd.aliases)
135
see_also = cmd.get_see_also()
137
see_also_str += '\nSee also: '
138
see_also_str += ', '.join(see_also)
141
return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
145
Man page for Bazaar (%(bzrcmd)s)
147
.\\\" Large parts of this file are autogenerated from the output of
148
.\\\" \"%(bzrcmd)s help commands\"
149
.\\\" \"%(bzrcmd)s help <cmd>\"
151
.\\\" Generation time: %(timestamp)s
157
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
159
Bazaar (%(bzrcmd)s) - next-generation distributed version control
174
Bazaar (or %(bzrcmd)s) is a project of Canonical to develop an open source
175
distributed version control system that is powerful, friendly, and scalable.
176
Version control means a system that keeps track of previous revisions
177
of software source code or similar information and helps people work on it in teams.
186
is to look for shell plugin external commands.
189
E-Mail address of the user. Overrides default user config.
192
E-Mail address of the user. Overrides default user config.
195
Editor for editing commit messages
198
Editor for editing commit messages
201
Paths where bzr should look for plugins
204
Home directory for bzr
207
.I "~/.bazaar/bazaar.conf"
208
Contains the user's default configuration. The section
210
is used to define general configuration that will be applied everywhere.
213
can be used to create command aliases for
214
commonly used options.
216
A typical config file might look something like:
221
email=John Doe <jdoe@isp.com>
225
commit = commit --strict
227
log10 = log --short -r -10..-1
229
.UR http://www.bazaar-vcs.org/
230
.BR http://www.bazaar-vcs.org/
added
removed
tools/doc_generate/autodoc_man.py
