mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

man pages: generate page for subparsers, eg. borg-key(1) 

Conflicts:
	docs/man/borg-key.1
This commit is contained in:
Marian Beermann 2017-02-11 15:45:09 +01:00
parent fa24e1f38f
commit 1d9378f12c
2 changed files with 20 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/man/borg-key.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-KEY 1 "2017-02-11" "" "borg backup tool"
.TH BORG-KEY 1 "2017-02-12" "" "borg backup tool"
.SH NAME
borg-key \- Manage a keyfile or repokey of a repository
.

30
setup.py
View File

@ -393,27 +393,35 @@ class build_man(Command):
man_title = 'borg-' + command.replace(' ', '-')
print('building man page', man_title + '(1)', file=sys.stderr)
if self.generate_level(command + ' ', parser, Archiver):
continue
is_intermediary = self.generate_level(command + ' ', parser, Archiver)
doc, write = self.new_doc()
self.write_man_header(write, man_title, parser.description)
self.write_heading(write, 'SYNOPSIS')
write('borg', command, end='')
self.write_usage(write, parser)
if is_intermediary:
subparsers = [action for action in parser._actions if 'SubParsersAction' in str(action.__class__)][0]
for subcommand in subparsers.choices:
write('| borg', command, subcommand, '...')
self.see_also.setdefault(command, []).append('%s-%s' % (command, subcommand))
else:
write('borg', command, end='')
self.write_usage(write, parser)
write('\n')
self.write_heading(write, 'DESCRIPTION')
description, _, notes = parser.epilog.partition('\n.. man NOTES')
write(description)
self.write_heading(write, 'OPTIONS')
write('See `borg-common(1)` for common options of Borg commands.')
write()
self.write_options(write, parser)
if description:
self.write_heading(write, 'DESCRIPTION')
write(description)
self.write_examples(write, command)
if not is_intermediary:
self.write_heading(write, 'OPTIONS')
write('See `borg-common(1)` for common options of Borg commands.')
write()
self.write_options(write, parser)
self.write_examples(write, command)
if notes:
self.write_heading(write, 'NOTES')