Use Fl Fl for long flags.

This commit is contained in:
wiz 2009-04-28 09:19:15 +00:00
parent 103ca7bc06
commit 4ad6ecab0a
1 changed files with 35 additions and 35 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: netpgp.1,v 1.2 2009/04/28 07:56:19 wiz Exp $ .\" $NetBSD: netpgp.1,v 1.3 2009/04/28 09:19:15 wiz Exp $
.\" .\"
.\" Copyright (c) 2009 The NetBSD Foundation, Inc. .\" Copyright (c) 2009 The NetBSD Foundation, Inc.
.\" All rights reserved. .\" All rights reserved.
@ -35,22 +35,22 @@
.Nd signing, verification, encryption, and decryption utility .Nd signing, verification, encryption, and decryption utility
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm netpgp .Nm netpgp
.Op Fl -armour .Op Fl Fl armour
.Op Fl -clearsign .Op Fl Fl clearsign
.Op Fl -decrypt .Op Fl Fl decrypt
.Op Fl -encrypt .Op Fl Fl encrypt
.Op Fl -export-key .Op Fl Fl export-key
.Op Fl -find-key .Op Fl Fl find-key
.Op Fl -generate-key .Op Fl Fl generate-key
.Op Fl -homedir Ns = Ns Ar home-directory .Op Fl Fl homedir Ns = Ns Ar home-directory
.Op Fl -import-key .Op Fl Fl import-key
.Op Fl -keyring Ns = Ns Ar keyring .Op Fl Fl keyring Ns = Ns Ar keyring
.Op Fl -list-keys .Op Fl Fl list-keys
.Op Fl -numbits Ns = Ns Ar numbits .Op Fl Fl numbits Ns = Ns Ar numbits
.Op Fl -sign .Op Fl Fl sign
.Op Fl -userid Ns = Ns Ar userid .Op Fl Fl userid Ns = Ns Ar userid
.Op Fl -verify .Op Fl Fl verify
.Op Fl -version .Op Fl Fl version
.Ar file ... .Ar file ...
.Sh DESCRIPTION .Sh DESCRIPTION
The The
@ -83,38 +83,38 @@ and imported (i.e. users who have signed our public key).
.Pp .Pp
One of the following commands must be present: One of the following commands must be present:
.Bl -tag -width Ar .Bl -tag -width Ar
.It Fl -clearsign .It Fl Fl clearsign
The signature of the file named on the command line is calculated The signature of the file named on the command line is calculated
in the same manner as the in the same manner as the
.Fl -sign .Fl Fl sign
command, but the text is added to the file such that command, but the text is added to the file such that
the text itself is not in binary format, but can be read by mere mortals. the text itself is not in binary format, but can be read by mere mortals.
.It Fl -decrypt .It Fl Fl decrypt
Decrypt the file using the user's private key. Decrypt the file using the user's private key.
The pass phrase will be optained by prompting the user The pass phrase will be optained by prompting the user
to type it in, using to type it in, using
.Xr getpass 3 . .Xr getpass 3 .
.It Fl -encrypt .It Fl Fl encrypt
Use the user's public key to encrypt the files named on the command line. Use the user's public key to encrypt the files named on the command line.
.It Fl -export-key .It Fl Fl export-key
Display the current public key in a format suitable for export. Display the current public key in a format suitable for export.
This can be used to place the keyring on one of the This can be used to place the keyring on one of the
public key servers, for example. public key servers, for example.
.It Fl -find-key .It Fl Fl find-key
Find the appropriate public key from the current keyring. Find the appropriate public key from the current keyring.
If no keyring is provided, the user's public keyring is used. If no keyring is provided, the user's public keyring is used.
.It Fl -generate-key .It Fl Fl generate-key
This command is used to generate a new public and private key pair. This command is used to generate a new public and private key pair.
The user id is taken from the command line, and the user will be The user id is taken from the command line, and the user will be
prompted to provide a suitable pass phrase. prompted to provide a suitable pass phrase.
.It Fl -import-key .It Fl Fl import-key
Import a public key as retrieved from one of the public key servers. Import a public key as retrieved from one of the public key servers.
This is in the form of a file which has previously been This is in the form of a file which has previously been
retrieved from elsewhere. retrieved from elsewhere.
.It Fl -list-keys .It Fl Fl list-keys
List all the public keys in the current keyring. List all the public keys in the current keyring.
If no keyring is provided, the user's public keyring is used. If no keyring is provided, the user's public keyring is used.
.It Fl -sign .It Fl Fl sign
The private key is used to digitally sign the files named on the The private key is used to digitally sign the files named on the
command line. command line.
Extra text is added to the file. Extra text is added to the file.
@ -129,10 +129,10 @@ The file and its attached signature are created with a
extension to the original file name. extension to the original file name.
The user will be prompted for their pass phrase using The user will be prompted for their pass phrase using
.Xr getpass 3 . .Xr getpass 3 .
.It Fl -verify .It Fl Fl verify
For each of the files named on the command line, the signature of the file For each of the files named on the command line, the signature of the file
is verified, checking the contents against the user's public signature. is verified, checking the contents against the user's public signature.
.It Fl -version .It Fl Fl version
Print the version information from the Print the version information from the
.Xr libnetpgp 3 .Xr libnetpgp 3
library. library.
@ -141,19 +141,19 @@ library.
In addition to one of the preceding commands, a number of qualifiers In addition to one of the preceding commands, a number of qualifiers
or options may be given. or options may be given.
.Bl -tag -width Ar .Bl -tag -width Ar
.It Fl -armour , -armor .It Fl Fl armour , Fl armor
This option, however it is spelled, wraps the signature as an This option, however it is spelled, wraps the signature as an
ASCII-encoded piece of text, for ease of use. ASCII-encoded piece of text, for ease of use.
.It Fl -homedir Ar home-directory .It Fl Fl homedir Ar home-directory
Keyrings are normally located, for historical reasons, within Keyrings are normally located, for historical reasons, within
the user's home directory in a subdirectory called the user's home directory in a subdirectory called
.Dq Pa .gnupg .Dq Pa .gnupg
and this option specifies an alternative location in which to and this option specifies an alternative location in which to
find that sub-directory. find that sub-directory.
.It Fl -keyring Ar keyring .It Fl Fl keyring Ar keyring
This option specifies an alternative keyring to be used. This option specifies an alternative keyring to be used.
All keyring operations will be relative to this alternative keyring. All keyring operations will be relative to this alternative keyring.
.It Fl -numbits Ar numbits .It Fl Fl numbits Ar numbits
specifies the number of bits to be used when generating a key. specifies the number of bits to be used when generating a key.
The default number of bits is 2048. The default number of bits is 2048.
This is considered the absolute This is considered the absolute
@ -161,7 +161,7 @@ minimum which should be chosen at the time of writing (2009).
Due to advances in computing power every year, this number should Due to advances in computing power every year, this number should
be reviewed, and increased when it becomes easier to factor 2048 be reviewed, and increased when it becomes easier to factor 2048
bit numbers. bit numbers.
.It Fl -userid Ar userid .It Fl Fl userid Ar userid
This option specifies the user identity to be used for all operations. This option specifies the user identity to be used for all operations.
This identity can either be in the form of the full name, or as an This identity can either be in the form of the full name, or as an
email address. email address.
@ -205,7 +205,7 @@ far-reaching consequences, users are strongly encouraged to
enter their pass phrases only when prompted by the application. enter their pass phrases only when prompted by the application.
.Pp .Pp
The The
.Fl -passphrase .Fl Fl passphrase
option is deprecated, and will be removed in future versions option is deprecated, and will be removed in future versions
of the tool. of the tool.
.Sh SIGNING AND VERIFICATION .Sh SIGNING AND VERIFICATION