~bzr-pqm/bzr/bzr.dev

1551.3.11 by Aaron Bentley
Merge from Robert
1
#!/usr/bin/python
2
3
# Copyright 2005 Canonical Ltd.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
4
#
1551.3.11 by Aaron Bentley
Merge from Robert
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
9
#
1551.3.11 by Aaron Bentley
Merge from Robert
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
# GNU General Public License for more details.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
14
#
1551.3.11 by Aaron Bentley
Merge from Robert
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
18
1551.3.11 by Aaron Bentley
Merge from Robert
19
"""%(prog)s - generate information from built-in bzr help
20
21
%(prog)s creates a file with information on bzr in one of
22
several different output formats:
23
24
    man              man page
25
    bash_completion  bash completion script
26
    ...
27
28
Examples: 
29
30
    python2.4 generated-docs.py man
31
    python2.4 generated-docs.py bash_completion
32
33
Run "%(prog)s --help" for the option reference.
34
"""
35
36
import sys
37
from optparse import OptionParser
38
39
import tools.doc_generate
40
41
def main(argv):
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
42
    parser = OptionParser(usage="""%prog [options] OUTPUT_FORMAT
43
44
Available OUTPUT_FORMAT:
45
46
    man              man page
47
    rstx             man page in ReStructuredText format
48
    bash_completion  bash completion script""")
1551.3.11 by Aaron Bentley
Merge from Robert
49
50
    parser.add_option("-s", "--show-filename",
51
                      action="store_true", dest="show_filename", default=False,
52
                      help="print default filename on stdout")
53
54
    parser.add_option("-o", "--output", dest="filename", metavar="FILE",
55
                      help="write output to FILE")
56
57
    parser.add_option("-b", "--bzr-name",
58
                      dest="bzr_name", default="bzr", metavar="EXEC_NAME",
59
                      help="name of bzr executable")
60
61
    parser.add_option("-e", "--examples",
62
                      action="callback", callback=print_extended_help,
63
                      help="Examples of ways to call generate_doc")
64
65
66
    (options, args) = parser.parse_args(argv)
67
68
    if len(args) != 2:
69
        parser.print_help()
70
        sys.exit(1)
71
72
    infogen_type = args[1]
73
    infogen_mod = tools.doc_generate.get_module(infogen_type)
74
75
    if options.filename:
76
        outfilename = options.filename
77
    else:
78
        outfilename = infogen_mod.get_filename(options)
79
80
    if outfilename == "-":
81
        outfile = sys.stdout
82
    else:
83
        outfile = open(outfilename,"w")
84
85
    if options.show_filename and (outfilename != "-"):
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
86
        sys.stdout.write(outfilename)
87
        sys.stdout.write('\n')
1551.3.11 by Aaron Bentley
Merge from Robert
88
    
89
    infogen_mod.infogen(options, outfile)
90
91
def print_extended_help(option, opt, value, parser):
92
    """ Program help examples
93
94
    Prints out the examples stored in the docstring. 
95
96
    """
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
97
    sys.stdout.write(__doc__ % {"prog":sys.argv[0]})
98
    sys.stdout.write('\n')
1551.3.11 by Aaron Bentley
Merge from Robert
99
    sys.exit(0)
100
101
if __name__ == '__main__':
102
    main(sys.argv)