From 4be442739c7f6745848a2f5544a59592f06a6cb3 Mon Sep 17 00:00:00 2001 From: Nils Gillmann Date: Fri, 26 Oct 2018 16:08:14 +0000 Subject: Start fixing the man pages via linting and style. Signed-off-by: Nils Gillmann --- doc/man/gnunet-identity.1 | 78 +++++++++++++++++++++++------------------------ 1 file changed, 38 insertions(+), 40 deletions(-) (limited to 'doc/man/gnunet-identity.1') diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1 index d20c3a0fa..8d009d07b 100644 --- a/doc/man/gnunet-identity.1 +++ b/doc/man/gnunet-identity.1 @@ -1,4 +1,4 @@ -.TH GNUNET-IDENTITY "1" "5 Sep 2013" "GNUnet" +.TH GNUNET-IDENTITY "1" "September 5, 2013" "GNUnet" .SH NAME gnunet\-identity \- create, delete or list egos .SH SYNOPSIS @@ -6,64 +6,62 @@ gnunet\-identity \- create, delete or list egos [options] .SH DESCRIPTION .PP -gnunet\-identity is a tool for managing egos. An ego is the persona -that controls a namespace. It is identical to a public\-private ECC -key pair. - +gnunet\-identity is a tool for managing egos. +An ego is the persona that controls a namespace. +It is identical to a public\-private ECC key pair. +.PP gnunet\-identity can be used to list all of the egos that were created locally, to create new egos, and to delete existing egos (the namespace will continue to exist, but it will be impossible to add additional data to it). - +.PP Creating a new ego requires using the \-C option together with an -identifier (name) that is to be used for the new ego. This identifier -is only used locally for this peer and not shared with other peers. - +identifier (name) that is to be used for the new ego. +This identifier is only used locally for this peer and not shared with +other peers. .TP -\fB\-C NAME\fR, \fB\-\-create=NAME\fR Creates a new ego with the given -NAME. - +\fB\-C NAME\fR, \fB\-\-create=NAME\fR +Creates a new ego with the given NAME. .TP -\fB\-D NAME\fR, \fB\-\-delete=NAME\fR Delete the ego with the given -NAME. - +\fB\-D NAME\fR, \fB\-\-delete=NAME\fR +Delete the ego with the given NAME. .TP -\fB\-e NAME\fR, \fB\-\-ego=NAME\fR Perform "set" operation with the -respective ego. Needs to be used together with option \-s. - +\fB\-e NAME\fR, \fB\-\-ego=NAME\fR +Perform "set" operation with the respective ego. +Needs to be used together with option \-s. .TP -\fB\-h\fR, \fB\-\-help\fR Print help page. - +\fB\-h\fR, \fB\-\-help\fR +Print help page. .TP -\fB\-d\fR, \fB\-\-display\fR display all of our egos - +\fB\-d\fR, \fB\-\-display\fR +display all of our egos .TP -\fB\-m\fR, \fB\-\-monitor\fR run in monitor mode, listing all ouf our -egos until CTRL-C is pressed. Each ego is listed together with a -unique pointer value; if egos are renamed, that pointer value remains -the same; if egos are deleted, they are listed one more time with a -name of "". - +\fB\-m\fR, \fB\-\-monitor\fR +Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. +Each ego is listed together with a unique pointer value; if egos are +renamed, that pointer value remains the same; if egos are deleted, +they are listed one more time with a name of "". .TP -\fB\-s SUBSYSTEM\fR, \fB\-\-set=SUBSYSTEM\fR Perform "set" operation -for the specified SUBSYSTEM with the respective ego. Needs to be used -together with option \-e. After this, the given SUBSYSTEM will use -the ego with the specified NAME. This will fail if NAME does not yet -exist. - - +\fB\-s SUBSYSTEM\fR, \fB\-\-set=SUBSYSTEM\fR +Perform "set" operation for the specified SUBSYSTEM with the +respective ego. +Needs to be used together with option \-e. +After this, the given SUBSYSTEM will use the ego with the specified +NAME. +This will fail if NAME does not yet exist. .SH FILES .TP ~/.local/share/gnunet/identity/egos Directory where the egos are stored (by default) - -.SH "REPORTING BUGS" -Report bugs by using Mantis or by sending electronic mail to -.SH "SEE ALSO" +.SH BUGS +Report bugs by using Mantis or by sending +electronic mail to +.SH SEE ALSO \fBgnunet\-gns\fP(1), \fBgnunet\-namestore\fP(1) The full documentation for .B gnunet -is maintained as a Texinfo manual. If the +is maintained as a Texinfo manual. +If the .B info and .B gnunet -- cgit v1.2.3