Skip to content

Commit 62b4a59

Browse files
lechnerjaymzh
lechner
authored and
jaymzh
committed
Manpages from Debian (#66)
* Manpages from Debian packaging. * Install manpages via setup.py
1 parent 6331c25 commit 62b4a59

File tree

5 files changed

+265
-0
lines changed

5 files changed

+265
-0
lines changed

‎doc/pius-keyring-mgr.1‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
.TH PIUS\-KEYRING\-MGR 1 "DECEMBER 2016"
2+
.SH NAME
3+
pius\-keyring\-mgr \- PIUS (PGP Individual UID Signer) Keyring Manager
4+
.SH SYNOPSIS
5+
.B pius\-keyring\-mgr
6+
.RI < mode >
7+
.RI [ options ]
8+
.SH DESCRIPTION
9+
.B pius\-keyring\-mgr
10+
has several modes to manage keyrings. It was designed for signing
11+
parties, but can be used for any PGP keyring. The \fImode\fP
12+
must be the first argument, with options as explained below.
13+
.SH OPTIONS
14+
.IP "\fB\-d\fP, \fB\-\-debug\fP"
15+
Enable debugging output.
16+
.IP "\fB\-g\fP \fIPATH\fP, \fB\-\-gpg\-path=\fP\fIPATH\fP"
17+
Path to gpg binary. [default: \fI/usr/bin/gpg2\fP]
18+
.IP "\fB\-r\fP \fIKEYRING\fP, \fB\-\-keyring=\fP\fIKEYRING\fP"
19+
Use this keyring.
20+
.IP "\fB\-v\fP, \fB\-\-verbose\fP"
21+
Print summaries.
22+
.SH MODES
23+
The \fBbuild\fP mode is used most of the time. It can parse a CSV file,
24+
automatically look for keys, and email anyone whose key was not
25+
be found. This mode can also import keys from an mbox file. The options are:
26+
.IP "\fB\-b\fP \fIMBOX\-FILE\fP, \fB\-\-mbox\-file=\fP\fIMBOX\-FILE\fP"
27+
Parse \fIMBOX\-FILE\fP and examine each message for PGP fingerprints
28+
or ascii-armored keys. Decodes messages as necessary.
29+
.IP "\fB\-c\fP \fICSV\-FILE\fP, \fB\-\-csv\-file=\fP\fICSV\-FILE\fP"
30+
Parse \fIMBOX\-FILE\fP and import keys. You will almost certainly also
31+
want -D, -E, -F and -N.
32+
.IP "\fB\-D\fP \fIDELIMITER\fP, \fB\-\-delimiter=\fP\fIDELIMITER\fP"
33+
Field delimiter to use when parsing CSV. Only meaningful with -c.
34+
[default: ',']
35+
.IP "\fB\-E\fP \fIEMAIL\-COLUMN\fP, \fB\-\-email\-field=\fP\fIEMAIL\-COLUMN\fP"
36+
Column number with the email address in the CSV file. Only meaningful with -c.
37+
[default: 3]
38+
.IP "\fB\-F\fP \fIFINGERPRINT\-COLUMN\fP, \fB\-\-fp\-field=\fP\fIFINGERPRINT\-COLUMN\fP"
39+
Column number with the GPG fingerprint in the CSV file. Only meaningful with -c.
40+
[default: 4]
41+
.IP "\fB\-m\fP \fIFROM\-EMAIL\fP, \fB\-\-mail=\fP\fIFROM\-EMAIL\fP"
42+
Email people whose keys were not located, using \fIFROM\-EMAIL\fP as sender.
43+
.IP "\fB\-M\fP \fIFILE\fP, \fB\-\-mail\-text=\fP\fIFILE\fP"
44+
Use the text in FILE as the body of email when sending emails instead
45+
of the default text. To see the default text use --print-default-email.
46+
Requires -m.
47+
.IP "\fB\-N\fP \fINAME\-COLUMN\fP, \fB\-\-name\-field=\fP\fINAME\-COLUMN\fP"
48+
Column number with the name in the CSV file.
49+
Only meaningful with -c. [default: 2]
50+
.IP "\fB\-n\fP \fITO\-EMAIL\fP, \fB\-\-override\-email=\fP\fITO\-EMAIL\fP"
51+
Rather than send to the user, send to this address. Mostly useful for debugging.
52+
.IP "\fB\-p\fP \fIPARTY-NAME\fP, \fB\-\-party=\fP\fIPARTY-NAME\fP"
53+
The name of the party. Will be printed in the email sent out.
54+
Only useful with -m.
55+
.IP "\fB\-s\fP \fIKEY\-SERVER\fP, \fB\-\-keyservers=\fP\fIKEY\-SERVER\fP"
56+
Try this keyserver. Specify once for each server (-s foo -s bar).
57+
[default: pool.sks-keyservers.net, pgp.mit.edu, keys.gnupg.net]
58+
.IP "\fB\-t\fP \fITEMP\-DIR\fP, \fB\-\-tmp\-dir=\fP\fITEMP\-DIR\fP"
59+
Directory to put temporary stuff in. [default: \fI/tmp/pius_keyring_mgr_tmp\fP]
60+
.IP "\fB\-T\fP, \fB\-\-print\-default\-email\fP"
61+
Print the default email.
62+
.IP "\fB\-\-ignore-emails=\fP\fIIGNORE\-EMAILS\fP"
63+
Comma-separated list of emails to ignore (no spaces).
64+
.IP "\fB\-\-ignore-fingerprints=\fP\fIIGNORE-FINGERPRINTS\fP"
65+
Comma-separated list of PGP fingerprints to ignore (no spaces).
66+
.PP
67+
The \fBprune\fP mode opens a keyring and, for each key, asks to remove it.
68+
Useful after a party to trim a keyring of people who didn't show, and
69+
before distributing the keyring to those who went. There are no options.
70+
.PP
71+
The \fBraw\fP mode passes options directly to gpg. Useful when adding
72+
keys by hand. Your options are added to those those necessary to work
73+
on the party keyring safely. (It does not load your personal keyring.)
74+
Your options must be passed after '\-\-' to prevent
75+
pius\-keyring\-manager from interpreting them as its own.
76+
.SH EXAMPLES
77+
Scan a CSV file and an MBOX for emails and write to anyone whose key was not
78+
found, using [email protected] as sender:
79+
.PP
80+
.nf
81+
/usr/bin/pius\-keyring\-mgr build \-\-csv\-file /tmp/report \-\-mbox\-file
82+
/tmp/mbox \-\-mail [email protected]
83+
.fi
84+
.PP
85+
Download a key and add it to the party keyring:
86+
.PP
87+
.nf
88+
pius\-keyring\-mgr raw \-r path/to/keyring.gpg \-\- \-\-recv\-key <keyid>
89+
.fi
90+
.SH AUTHOR
91+
PIUS was written by Phil Dibowitz <[email protected]>
92+
.PP
93+
This manual page was written by Felix Lechner <[email protected]>
94+
for the Debian project, but may be used by others.

‎doc/pius-party-worksheet.1‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.TH PIUS\-PARTY\-WORKSHEET 1 "DECEMBER 2016"
2+
.SH NAME
3+
pius\-party\-worksheet \- PIUS (PGP Individual UID Signer) Party Worksheet Generator
4+
.SH SYNOPSIS
5+
.B pius\-party\-worksheet
6+
.RI [ options ]
7+
.RI < keyring >
8+
> outfile.html
9+
.SH DESCRIPTION
10+
.B pius\-party\-worksheet
11+
is a small utility to generate a worksheet for a key signing party.
12+
Attendees will find it easier and faster to verify keys and identities using
13+
this sheet. They can use it as a guide to sign keys after the party.
14+
.SH OPTIONS
15+
.IP "\fB\-e\fP, \fB\-\-extra\-fields\fP [\fIFIELD\fP, ... ]"
16+
Comma-separated list of extra columns. Useful if some participants plan
17+
to do something extra, such as S/MIME or CA Cert verification.
18+
.IP "\fB\-h\fP, \fB\-\-help\fP"
19+
Show this help message and exit.
20+
.IP "\fB\-v\fP, \fB\-\-version\fP"
21+
Show program version number and exit.
22+
.SH AUTHOR
23+
PIUS was written by Phil Dibowitz <[email protected]>
24+
.PP
25+
This manual page was written by Felix Lechner <[email protected]>
26+
for the Debian project, but may be used by others.

‎doc/pius-report.1‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.TH PIUS\-REPORT 1 "DECEMBER 2016"
2+
.SH NAME
3+
pius\-report \- PIUS (PGP Individual UID Signer) Report Tool
4+
.SH SYNOPSIS
5+
.B pius\-report
6+
.RI [ options ]
7+
.SH DESCRIPTION
8+
.B pius\-report
9+
sends out reminders to participants of a keysigning party, pointing
10+
out what they still need to do. The reminders are personalized.
11+
.SH OPTIONS
12+
.IP "\fB\-h\fP, \fB\-\-help\fP"
13+
show this help message and exit
14+
.IP "\fB\-b\fP \fIPATH\fP, \fB\-\-gpg\-path=\fP\fIPATH\fP"
15+
Path to gpg binary. [default: \fI/usr/bin/gpg\fP]
16+
.IP "\fB\-d\fP, \fB\-\-debug\fP"
17+
Enable debugging output.
18+
.IP "\fB\-s\fP \fIKEYID\fP, \fB\-\-signer=\fP\fIKEYID\fP"
19+
The key you sign with.
20+
.IP "\fB\-r\fP \fIKEYRING\fP, \fB\-\-keyring=\fP\fIKEYRING\fP"
21+
Party keyring to use.
22+
.IP "\fB\-m\fP \fIEMAIL\-ADDRESS\fP, \fB\-\-mail=\fP\fIEMAIL\-ADDRESS\fP"
23+
Email the encrypted, signed keys to the respective email addresses. \fIEMAIL-ADDRESS\fP is the address to send from. See also \fB\-H\fP and \fB\-P\fP.
24+
.IP "\fB\-t\fP \fITEMP\-DIR\fP, \fB\-\-tmp\-dir=\fP\fITEMP\-DIR\fP"
25+
Directory to put temporary stuff in. [default: none]
26+
.IP "\fB\-p\fP \fINAME\fP, \fB\-\-party=\fP\fINAME\fP"
27+
Name of the party. This will be printed in the emails sent. Only useful with -m.
28+
.IP "\fB\-\-no\-refresh\fP"
29+
Do not refresh keys.
30+
.IP "\fB\-u\fP \fIUSER\fP, \fB\-\-mail\-user=\fP\fIUSER\fP"
31+
Authenticate to the SMTP server with username \fIUSER\fP. You will be prompted for the password.
32+
.IP "\fB\-S\fP, \fB\-\-no\-mail\-tls\fP"
33+
Do not use STARTTLS when talking to the SMTP server.
34+
.IP "\fB\-P\fP \fIPORT\fP, \fB\-\-mail\-port=\fP\fIPORT\fP"
35+
\fIPort\fP of SMTP server. [default: 587]
36+
.IP "\fB\-O\fP, \fB\-\-no\-pgp\-mime\fP"
37+
Do not use PGP/Mime when sending email.
38+
.IP "\fB\-n\fP \fIEMAIL\-ADDRESS\fP, \fB\-\-override\-email=\fP\fIEMAIL\-ADDRESS\fP"
39+
Rather than send to the user, send to this address. Mostly useful for debugging.
40+
.IP "\fB\-M\fP \fIFILE\fP, \fB\-\-mail\-text=\fP\fIFILE\fP"
41+
Use the text in \fIFILE\fP as the body of email when sending out emails instead of the default text. To see the default text use \fB\-\-print\-default\-email\fP. Requires \fB\-m\fP.
42+
.IP "\fB\-H\fP \fIHOSTNAME\fP, \fB\-\-mail\-host=\fP\fIHOSTNAME\fP"
43+
Hostname of SMTP server. [default: \fIlocalhost\fP]
44+
.SH AUTHOR
45+
PIUS-REPORT was written by Phil Dibowitz <[email protected]>
46+
.PP
47+
This manual page was written by Felix Lechner <[email protected]> for the Debian project, but may be used by others.

‎doc/pius.1‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
.TH PIUS 1 "DECEMBER 2016"
2+
.SH NAME
3+
pius \- PGP Individual UID Signer
4+
.SH SYNOPSIS
5+
.B pius
6+
.RI [ options ]
7+
.B \-s
8+
.RI < signer-keyid >
9+
.RI < keyid >
10+
[
11+
.RI < keyid >
12+
\& ... ]
13+
.br
14+
.B pius
15+
.RI [ options ]
16+
.B \-A \-r
17+
.RI < keyring-path >
18+
.B \-s
19+
.RI < signer-keyid >
20+
.SH DESCRIPTION
21+
.B pius
22+
is a tool for individually signing all of the UIDs on a set of keys,
23+
and emailing an encrypted copy of each such signature to the email
24+
address associated with that UID.
25+
.PP
26+
As a result of this process, the recipient can choose which signatures
27+
to import. Also, signatures of inactive uids are not delivered. This
28+
tool greatly reduces time and error when signing keys.
29+
.SH OPTIONS
30+
.IP \fB\-\-version\fP
31+
show program's version number and exit
32+
.IP "\fB\-h\fP, \fB\-\-help\fP"
33+
show this help message and exit
34+
.IP "\fB\-a\fP, \fB\-\-use\-agent\fP"
35+
Use gpg-agent instead of letting gpg prompt the user or every UID. [default: true]
36+
.IP "\fB\-A\fP, \fB\-\-all\-keys\fP"
37+
Sign all keys on the keyring. Requires \fB\-r\fP.
38+
.IP "\fB\-d\fP, \fB\-\-debug\fP"
39+
Enable debugging output.
40+
.IP "\fB\-b\fP \fIPATH\fP, \fB\-\-gpg\-path=\fP\fIPATH\fP"
41+
Path to gpg binary. [default: \fI/usr/bin/gpg2\fP]
42+
.IP "\fB\-e\fP, \fB\-\-encrypt\-outfiles\fP"
43+
Encrypt output files with respective keys.
44+
.IP "\fB\-H\fP \fIHOSTNAME\fP, \fB\-\-mail\-host=\fP\fIHOSTNAME\fP"
45+
Hostname of SMTP server. [default: \fIlocalhost\fP]
46+
.IP "\fB\-i\fP, \fB\-\-interactive\fP"
47+
Use the pexpect module for signing and drop to the gpg shell for entering the passphrase. [default: false]
48+
.IP "\fB\-I\fP, \fB\-\-import\fP"
49+
Also import the unsigned keys from the keyring into the default keyring. Ignored if \fB\-r\fP is not specified, or if it's the same as the default keyring.
50+
.IP "\fB\-m\fP \fIFROM\-EMAIL\fP, \fB\-\-mail=\fP\fIFROM\-EMAIL\fP"
51+
Email the encrypted, signed keys to the respective email addresses using \fIFROM\-EMAIL\fP as the sender. See also \fB\-H\fP and \fB\-P\fP.
52+
.IP "\fB\-M\fP \fIFILE\fP, \fB\-\-mail\-text=\fP\fIFILE\fP"
53+
Use the text in \fIFILE\fP as the body of email when sending out emails instead of the default text. To see the default text use \fB\-\-print\-default\-email\fP. Requires \fB\-m\fP.
54+
.IP "\fB\-N\fP, \fB\-\-no\-sort\-keyring\fP"
55+
Do not sort the keyring by name.
56+
.IP "\fB\-n\fP \fITO\-EMAIL\fP, \fB\-\-override\-email=\fP\fITO\-EMAIL\fP"
57+
Rather than send to the user, send to this address. Mostly useful for debugging.
58+
.IP "\fB\-o\fP \fIOUTPUT\-DIR\fP, \fB\-\-out\-dir=\fP\fIOUTPUT\-DIR\fP"
59+
Directory to put signed keys in. [default: \fI/tmp/pius_out\fP]
60+
.IP "\fB\-O\fP, \fB\-\-no\-pgp\-mime\fP"
61+
Do not use PGP/Mime when sending email.
62+
.IP "\fB\-p\fP, \fB\-\-cache\-passphrase\fP"
63+
Cache private key passphrase in memory and provide it to gpg instead of letting gpg prompt the user for every UID. [default: false]
64+
.IP "\fB\-P\fP \fIPORT\fP, \fB\-\-mail\-port=\fP\fIPORT\fP"
65+
\fIPort\fP of SMTP server. [default: 25]
66+
.IP "\fB\-r\fP \fIKEYRING\fP, \fB\-\-keyring=\fP\fIKEYRING\fP"
67+
The keyring to use. Be sure to specify full or relative path. Just a filename will cause GPG to assume relative to \fI~/.gnupg\fP. [default: \fI~/.gnupg/pubring.gpg\fP]
68+
.IP "\fB\-s\fP \fISIGNER\-KEYID\fP, \fB\-\-signer=\fP\fISIGNER\-KEYID\fP"
69+
The keyid to sign with (required).
70+
.IP "\fB\-f\fP \fIKEYID\fP, \fB\-\-force\-signer=\fP\fIKEYID\fP"
71+
Force GnuPG to use this exact keyid to sign (do not guess subkey)
72+
.IP "\fB\-S\fP, \fB\-\-no\-mail\-tls\fP"
73+
Do not use STARTTLS when talking to the SMTP server.
74+
.IP "\fB\-t\fP \fITEMP\-DIR\fP, \fB\-\-tmp\-dir=\fP\fITEMP\-DIR\fP"
75+
Directory to put temporary stuff in. [default: \fI/tmp/pius_tmp\fP]
76+
.IP "\fB\-T\fP, \fB\-\-print\-default\-email\fP"
77+
Print the default email.
78+
.IP "\fB\-u\fP \fIUSER\fP, \fB\-\-mail\-user=\fP\fIUSER\fP"
79+
Authenticate to the SMTP server with username \fIUSER\fP. You will be prompted for the password.
80+
.IP "\fB\-U\fP \fIPOLICY\-URL\fP, \fB\-\-policy\-url=\fP\fIPOLICY\-URL\fP"
81+
Policy URL to include in each signature.
82+
.IP "\fB\-v\fP, \fB\-\-verbose\fP"
83+
Be more verbose.
84+
.SH AUTHOR
85+
PIUS was written by Phil Dibowitz <[email protected]>
86+
.PP
87+
This manual page was written by Luke Cycon <[email protected]> and Felix Lechner <[email protected]>
88+
for the Debian project, but may be used by others.

‎setup.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,14 @@
88
packages=['libpius'],
99
requires=['six'],
1010
scripts=['pius', 'pius-keyring-mgr', 'pius-party-worksheet', 'pius-report'],
11+
data_files=[
12+
(
13+
'share/man/man1', [
14+
'doc/pius-keyring-mgr.1',
15+
'doc/pius.1',
16+
'doc/pius-report.1',
17+
'doc/pius-party-worksheet.1'
18+
]
19+
)
20+
]
1121
)

0 commit comments

Comments
 (0)