From: ng0 Date: Wed, 16 Oct 2019 18:15:04 +0000 (+0000) Subject: *.1: syntax (\- -> -) X-Git-Tag: v0.11.7~40 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=7e154ba25582715152aef9b4bc655ff2381edfc7;p=oweals%2Fgnunet.git *.1: syntax (\- -> -) --- diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1 index 0a0e8f702..0a50de21c 100644 --- a/doc/man/gnunet-auto-share.1 +++ b/doc/man/gnunet-auto-share.1 @@ -30,17 +30,17 @@ a command line tool to automatically share an entire directory with other users .Sh SYNOPSIS .Nm -.Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl D | \-disable-extractor -.Op Fl d | \-disable-creation-time -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME -.Op Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY -.Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL -.Op Fl V | \-verbose -.Op Fl v | \-version +.Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl D | -disable-extractor +.Op Fl d | -disable-creation-time +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME +.Op Fl p Ar PRIORITY | Fl -prio= Ns Ar PRIORITY +.Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL +.Op Fl V | -verbose +.Op Fl v | -version .Ao Ar DIRNAME Ac .Sh DESCRIPTION In order to share files with other GNUnet users, the files must first be made available to GNUnet. @@ -55,7 +55,7 @@ gnunet-auto-share has many options in common with gnunet-publish, but can only b You can use automatic meta-data extraction (based on libextractor). The options are as follows: .Bl -tag -width indent -.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL +.It Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL This option can be used to specify additional anonymity constraints. The default is 1. If set to 0, GNUnet will publish the file non-anonymously and in fact sign the advertisement for the file using your peer's private key. @@ -63,42 +63,42 @@ This will allow other users to download the file as fast as possible, including If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. You can gain better privacy by specifying a higher level of anonymity (using values above 1). -This tells FS that it must hide your own requests in equivalent\-looking cover traffic. +This tells FS that it must hide your own requests in equivalent-looking cover traffic. This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity. However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available. The specific numeric value (for anonymity levels above 1) is simple: -Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L\-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period. +Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period. The time-period is twice the average delay by which GNUnet artificially delays traffic. Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use alternate config file (if this option is not specified, the default is .Pa ~/.config/gnunet.conf Ns ). -.It Fl D | \-disable-extractor +.It Fl D | -disable-extractor Disable use of GNU libextractor for finding additional keywords and metadata. -.It Fl d | \-disable-creation-time +.It Fl d | -disable-creation-time Disable adding the creation time to the metadata of the uploaded file. -.It Fl h | \-help +.It Fl h | -help Print a brief help page with all the options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. -.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME +.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME Configure logging to write logs to FILENAME. -.It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY +.It Fl p Ar PRIORITY | Fl -prio= Ns Ar PRIORITY Executive summary: You probably don't need it. Set the priority of the published content (default: 365). If the local database is full, GNUnet will discard the content with the lowest ranking. Note that ranks change over time depending on popularity. The default should be high enough to preserve the locally published content in favor of content that migrates from other peers. -.It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL +.It Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL Set the desired replication level. If CONTENT_PUSHING is set to YES, GNUnet will push each block (for the file) LEVEL times to other peers before doing normal "random" replication of all content. This option can be used to push some content out into the network harder. Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas. -.It Fl V | \-verbose +.It Fl V | -verbose Be verbose. Using this option causes gnunet-publish to print progress information and at the end the file identification that can be used to download the file from GNUnet. -.It Fl v | \-version +.It Fl v | -version Print the version number. .El .Sh EXAMPLES diff --git a/doc/man/gnunet-bcd.1 b/doc/man/gnunet-bcd.1 index 0a1399ba3..edc0fea41 100644 --- a/doc/man/gnunet-bcd.1 +++ b/doc/man/gnunet-bcd.1 @@ -30,11 +30,11 @@ run HTTP server to create GNS business cards .Sh SYNOPSIS .Nm -.Op Fl p Ar PORT | Fl \-port= Ns Ar PORT -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl v | \-version +.Op Fl p Ar PORT | Fl -port= Ns Ar PORT +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl v | -version .Sh DESCRIPTION .Nm can be used to create an business card with a QR code containing the public key of a zone from the GNU Name System. @@ -45,16 +45,16 @@ If it does not work for you, try installing the full TeXLive distribution first, .Xr apt 1 execute "apt-get install texlive-full". .Bl -tag -width indent -.It Fl p Ar PORT | Fl \-port= Ns Ar PORT +.It Fl p Ar PORT | Fl -port= Ns Ar PORT Run the HTTP server on port PORT. -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .Sh SEE ALSO diff --git a/doc/man/gnunet-cadet.1 b/doc/man/gnunet-cadet.1 index bb2ce637e..fcc4fb2a5 100644 --- a/doc/man/gnunet-cadet.1 +++ b/doc/man/gnunet-cadet.1 @@ -30,18 +30,18 @@ create or obtain information about CADET tunnels and peers .Sh SYNOPSIS .Nm -.Op Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID -.Op Fl d | \-dump -.Op Fl e | \-echo -.Op Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET -.Op Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID -.Op Fl P | \-peers -.Op Fl T | \-tunnels -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl v | \-version +.Op Fl C Ar CONNECTION_ID | Fl -connection= Ns Ar CONNECTION_ID +.Op Fl d | -dump +.Op Fl e | -echo +.Op Fl o Ar SHARED_SECRET | Fl -open-port= Ns Ar SHARED_SECRET +.Op Fl p Ar PEER_ID | Fl -peer= Ns Ar PEER_ID +.Op Fl P | -peers +.Op Fl T | -tunnels +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl v | -version .Ao Ar PEER_ID Ac .Ao Ar SHARED_SECRET Ac .Sh DESCRIPTION @@ -63,36 +63,36 @@ For one-to-many communication .Xr gnunet-social 1 may be better suited, however. .Bl -tag -width indent -.It Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID +.It Fl C Ar CONNECTION_ID | Fl -connection= Ns Ar CONNECTION_ID Provide information about the connection .Ar CONNECTION_ID . -.It Fl d | \-dump +.It Fl d | -dump Dump debug information to stderr. -.It Fl e | \-echo +.It Fl e | -echo Activate echo mode. -.It Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET +.It Fl o Ar SHARED_SECRET | Fl -open-port= Ns Ar SHARED_SECRET Listen for connections using a shared secret, provided as .Ar SHARED_SECRET , among sender and recipient. -.It Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID +.It Fl p Ar PEER_ID | Fl -peer= Ns Ar PEER_ID Provide information about the peer .Ar PEER_ID . -.It Fl P | \-peers +.It Fl P | -peers Provide information about all (known) peers. -.It Fl T | \-tunnels +.It Fl T | -tunnels Provide information about all tunnels. -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file .Ar FILENAME . -.It Fl h | \-help +.It Fl h | -help Print the help page. -.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME +.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME Configure logging to write logs to .Ar FILENAME . -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl v | \-version +.It Fl v | -version Print the GNUnet version number. .El .Sh SEE ALSO diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1 index 95dc98811..e5babce2d 100644 --- a/doc/man/gnunet-config.1 +++ b/doc/man/gnunet-config.1 @@ -30,47 +30,47 @@ manipulate GNUnet configuration files .Sh SYNOPSIS .Nm -.Op Fl b Ar BACKEND | Fl \-supported-backend= Ns Ar BACKEND -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl f | \-filename -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl o Ar OPTION | Fl \-option= Ns Ar OPTION -.Op Fl S |\-list-sections -.Op Fl s Ar SECTION | Fl \-section= Ns Ar SECTION -.Op Fl V Ar VALUE | Fl \-value Ar VALUE -.Op Fl v | \-version -.Op Fl W | \-rewrite +.Op Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl f | -filename +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl o Ar OPTION | Fl -option= Ns Ar OPTION +.Op Fl S |-list-sections +.Op Fl s Ar SECTION | Fl -section= Ns Ar SECTION +.Op Fl V Ar VALUE | Fl -value Ar VALUE +.Op Fl v | -version +.Op Fl W | -rewrite .Sh DESCRIPTION .Nm can be used to read or modify GNUnet configuration files. .Bl -tag -width indent -.It Fl b Ar BACKEND | Fl \-supported-backend= Ns Ar BACKEND +.It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND Tests whether the specified BACKEND is supported by the current installation. The backend must match the name of a plugin, i.e. "namestore_postgres" for the Postgres database backend of the "NAMESTORE" service. If the BACKEND is supported, gnunet-config will return a status code of 0 (success), otherwise 77 (unsupported). When this option is specified, no other options may be specified. Specifying this option together with other options will cause gnunet-config to return a status code of 1 (error). -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl f | \-filename +.It Fl f | -filename Try to perform expansions as if the option values represent filenames (will also be applied even if the option is not really a filename). -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl o Ar OPTION | Fl \-option= Ns Ar OPTION +.It Fl o Ar OPTION | Fl -option= Ns Ar OPTION Which configuration option should be accessed or edited. Required to set a value. If not given, all values of a given section will be printed in the format "OPTION = VALUE". -.It Fl S |\-list-sections -List available configuration sections for use with \-\-section. -.It Fl s Ar SECTION | Fl \-section= Ns Ar SECTION +.It Fl S |-list-sections +List available configuration sections for use with --section. +.It Fl s Ar SECTION | Fl -section= Ns Ar SECTION Which configuration section should be accessed or edited. Required option. -.It Fl V Ar VALUE | Fl \-value Ar VALUE +.It Fl V Ar VALUE | Fl -value Ar VALUE Configuration value to store in the given section under the given option. -Must only be given together with \-s and \-o options. -.It Fl v | \-version +Must only be given together with -s and -o options. +.It Fl v | -version Print GNUnet version number. -.It Fl W | \-rewrite +.It Fl W | -rewrite Consider differences to defaults only. .El .Sh SEE ALSO diff --git a/doc/man/gnunet-conversation-test.1 b/doc/man/gnunet-conversation-test.1 index 1cc445f6f..395f27244 100644 --- a/doc/man/gnunet-conversation-test.1 +++ b/doc/man/gnunet-conversation-test.1 @@ -30,26 +30,26 @@ check your speaker and microphone settings .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl v | \-version +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl v | -version .Ao Ar URI Ac .Sh DESCRIPTION .Nm can be used to check your speaker and microphone settings. It will record you for five seconds and then play the recording back to you. If this fails, you might want to use the \fBpavucontrol\fP tool to check which microphone or speaker were assigned to GNUnet by PulseAudio (you may have more than one set of microphones or speakers known to your computer). -You can use gnunet\-conversation\-test without having a peer running on your computer. +You can use gnunet-conversation-test without having a peer running on your computer. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .\".Sh EXAMPLES diff --git a/doc/man/gnunet-conversation.1 b/doc/man/gnunet-conversation.1 index 62909224d..c319a231b 100644 --- a/doc/man/gnunet-conversation.1 +++ b/doc/man/gnunet-conversation.1 @@ -30,34 +30,34 @@ have a conversation with your peers .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl e Ar NAME | Fl \-ego= Ns Ar NAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl p Ar LINE | Fl \-phone= Ns Ar LINE -.Op Fl v | \-version +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl e Ar NAME | Fl -ego= Ns Ar NAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl p Ar LINE | Fl -phone= Ns Ar LINE +.Op Fl v | -version .Ao Ar URI Ac .Sh DESCRIPTION .Nm can be used to have a conversation with other GNUnet users. You can make calls and receive incoming calls. -You need to setup an ego using gnunet\-identity first. -For others to be able to call you, you must add a PHONE record to your zone in the GNU Name System (using gnunet\-namestore). -gnunet\-conversation has an interactive help system via the /help command. +You need to setup an ego using gnunet-identity first. +For others to be able to call you, you must add a PHONE record to your zone in the GNU Name System (using gnunet-namestore). +gnunet-conversation has an interactive help system via the /help command. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl e Ar NAME | Fl \-ego= Ns Ar NAME +.It Fl e Ar NAME | Fl -ego= Ns Ar NAME Specifies the NAME of the ego to use (for caller ID). -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl p Ar LINE | Fl \-phone= Ns Ar LINE +.It Fl p Ar LINE | Fl -phone= Ns Ar LINE Optional argument that can be used to specify the phone LINE to be used with the conversation service. The default LINE is zero, which should be fine for most users. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .\".Sh EXAMPLES diff --git a/doc/man/gnunet-datastore.1 b/doc/man/gnunet-datastore.1 index fede02185..81347dcae 100644 --- a/doc/man/gnunet-datastore.1 +++ b/doc/man/gnunet-datastore.1 @@ -31,7 +31,7 @@ .Nm .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME .Op Fl d | -dump -.Op Fl f Ar FILENAME | Fl \-file= Ns Ar FILENAME +.Op Fl f Ar FILENAME | Fl -file= Ns Ar FILENAME .Op Fl h | -help .Op Fl i | -insert .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL diff --git a/doc/man/gnunet-directory.1 b/doc/man/gnunet-directory.1 index 4a0696179..65c8e41ae 100644 --- a/doc/man/gnunet-directory.1 +++ b/doc/man/gnunet-directory.1 @@ -30,10 +30,10 @@ display directories .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl v | \-version +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl v | -version .Ao Ar FILENAME Ac .Sh DESCRIPTION .Nm @@ -42,15 +42,15 @@ A GNUnet directory is a binary file that contains a list of GNUnet file-sharing The names of the directory files must be passed as command-line arguments to gnunet-directory. The options are as follows: .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Configuration file to use. This option is useless, since gnunet-directory does not really depend on any configuration options. -.It Fl h | \-help +.It Fl h | -help Print the help page. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. -.It Fl v | \-version +.It Fl v | -version Print the version number. .El .Ss NOTES diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1 index 56f18e050..951c4a979 100644 --- a/doc/man/gnunet-download.1 +++ b/doc/man/gnunet-download.1 @@ -30,24 +30,24 @@ a command line interface for downloading files from GNUnet .Sh SYNOPSIS .Nm -.Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl D | \-delete\-incomplete -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl n | \-no-network -.Op Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME -.Op Fl p Ar DOWNLOADS | Fl \-parallelism= Ns Ar DOWNLOADS -.Op Fl r Ar REQUESTS | Fl \-request-parallelism= Ns Ar REQUESTS -.Op Fl R | \-recursive -.Op Fl v | \-version -.Op Fl V | \-verbose +.Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl D | -delete-incomplete +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl n | -no-network +.Op Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME +.Op Fl p Ar DOWNLOADS | Fl -parallelism= Ns Ar DOWNLOADS +.Op Fl r Ar REQUESTS | Fl -request-parallelism= Ns Ar REQUESTS +.Op Fl R | -recursive +.Op Fl v | -version +.Op Fl V | -verbose .Ao Ar GNUNET_URI Ac .Sh DESCRIPTION Download files from GNUnet. The options are as follows: .Bl -tag -width indent -.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL +.It Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL This option can be used to specify additional anonymity constraints. The default is 1. If set to 0, GNUnet will publish the file non-anonymously and in fact sign the advertisement for the file using your peer's private key. @@ -62,22 +62,22 @@ The specific numeric value (for anonymity levels above 1) is simple: Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period. The time-period is twice the average delay by which GNUnet artificially delays traffic. Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use config file (default: .Pa ~/.config/gnunet.conf Ns ) -.It Fl D | \-delete\-incomplete +.It Fl D | -delete-incomplete Causes gnunet-download to delete incomplete downloads when aborted with CTRL-C. Note that complete files that are part of an incomplete recursive download will not be deleted even with this option. Without this option, terminating gnunet-download with a signal will cause incomplete downloads to stay on disk. If gnunet-download runs to (normal) completion finishing the download, this option has no effect. -.It Fl h | \-help +.It Fl h | -help Print the help page. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. -.It Fl n | \-no-network +.It Fl n | -no-network Only search locally, do not forward requests to other peers. -.It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME +.It Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME Write the file to .Ar FILENAME . Hint: when recursively downloading a directory, append a '/' to the end of the FILENAME to create a directory of that name. @@ -85,7 +85,7 @@ If no FILENAME is specified, gnunet-download constructs a temporary ID from the The final filename is constructed based on meta-data extracted using .Xr libextractor 1 (if available). -.It Fl p Ar DOWNLOADS | Fl \-parallelism= Ns Ar DOWNLOADS +.It Fl p Ar DOWNLOADS | Fl -parallelism= Ns Ar DOWNLOADS Set the maximum number of allowed parallel downloads to .Ar DOWNLOADS . More parallel downloads can, to some extent, improve the overall time to download content. @@ -97,7 +97,7 @@ This option is used to limit the number of files that are downloaded in parallel can be used to limit the number of blocks that are concurrently requested. As a result, the value only matters for recursive downloads. The default value is 32. -.It Fl r Ar REQUESTS | Fl \-request-parallelism= Ns Ar REQUESTS +.It Fl r Ar REQUESTS | Fl -request-parallelism= Ns Ar REQUESTS Set the maximum number of parallel requests that is allowed. If multiple files are downloaded, gnunet-download will not run them in parallel if this would cause the number of pending requests to possibly exceed the given value. This is useful since, for example, downloading dozens of multi-gigabyte files in parallel could exhaust memory resources and would hardly improve performance. @@ -107,16 +107,16 @@ Consider raising this limit for large recursive downloads with many large files is not reached. This option also only matters for recursive downloads. The default value is 4092. -.It Fl R | \-recursive +.It Fl R | -recursive Download directories recursively (and in parallel). Note that the URI must belong to a GNUnet directory and that the filename given to .Fl o must end in '.gnd' \(em otherwise, you will receive an error. You may want to use "DIRNAME/.gnd" for the filename, this way a directory "DIRNAME/" will be created, and GNUnet's internal directory information will be stored in "DIRNAME/.gnd". However, it is also possible to specify "DIRNAME.gnd", in which case the files from the directory will end up in "DIRNAME/", while GNUnet's directory meta data will be in "DIRNAME.gnd". -.It Fl v | \-version +.It Fl v | -version Print the version number. -.It Fl V | \-verbose +.It Fl V | -verbose Print progress information. .El .Ss NOTES diff --git a/doc/man/gnunet-fs.1 b/doc/man/gnunet-fs.1 index e87d9a3e2..f964acbb1 100644 --- a/doc/man/gnunet-fs.1 +++ b/doc/man/gnunet-fs.1 @@ -29,12 +29,12 @@ .Nd measure and control the FS subsystem .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl i | \-list-indexed -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl v | \-version -.Op Fl V | \-verbose +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl i | -list-indexed +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl v | -version +.Op Fl V | -verbose .Sh DESCRIPTION .Nm is a tool to access various functions of GNUnet's FS subsystem @@ -43,18 +43,18 @@ Most of these are not expected to be useful for end-users. gnunet-fs can currently only be used to obtain a list of indexed files. Other functions should be added in the near future. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Configuration file to use. -.It Fl h | \-help +.It Fl h | -help Print the help page. -.It Fl i | \-list-indexed +.It Fl i | -list-indexed Print information about files that are currently indexed by file-sharing. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. -.It Fl v | \-version +.It Fl v | -version Print the version number. -.It Fl V | \-verbose +.It Fl V | -verbose Be verbose. .El .Sh SEE ALSO diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1 index d985ee0d9..770cb4fe2 100644 --- a/doc/man/gnunet-gns-proxy.1 +++ b/doc/man/gnunet-gns-proxy.1 @@ -30,35 +30,35 @@ run a client side GNS SOCKS proxy .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl a Ar AUTHORITY | Fl \-authority= Ns Ar AUTHORITY -.Op Fl p Ar PORT | Fl \-port= Ns Ar PORT -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl v | \-version +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl a Ar AUTHORITY | Fl -authority= Ns Ar AUTHORITY +.Op Fl p Ar PORT | Fl -port= Ns Ar PORT +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl v | -version .Sh DESCRIPTION Most users will want to run this SOCKS proxy. It can be used in combination with browsers that support the SOCKS 4a protocol. .Pp The proxy will perform SSL authentication of GNS names and rewrite GNS enabled HTML content. To assert the validity of GNS names a local root CA certificate has to be generated that is used by the proxy. -Thus "gnunet-gns-proxy-setup-ca" should be executed before the first launch of this proxy or the \-\-authority switch is used to specify an appropriate CA certificate that is already trusted by the browser. +Thus "gnunet-gns-proxy-setup-ca" should be executed before the first launch of this proxy or the --authority switch is used to specify an appropriate CA certificate that is already trusted by the browser. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl a Ar AUTHORITY | Fl \-authority= Ns Ar AUTHORITY +.It Fl a Ar AUTHORITY | Fl -authority= Ns Ar AUTHORITY Path to a PEM CA file that contains the certificate and private key of the CA to use to assert the validity of GNS names. The default port is specified in the configuration file for the gns service under "[gns-proxy]": "[gns-proxy]" PROXY_CACERT -.It Fl p Ar PORT | Fl \-port= Ns Ar PORT +.It Fl p Ar PORT | Fl -port= Ns Ar PORT The port this proxy should listen on. Default is 7777. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .\".Sh EXAMPLES diff --git a/doc/man/gnunet-gns.1 b/doc/man/gnunet-gns.1 index 0743290b4..310198f74 100644 --- a/doc/man/gnunet-gns.1 +++ b/doc/man/gnunet-gns.1 @@ -30,43 +30,43 @@ access to GNU Name System .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME -.Op Fl r | \-raw -.Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE -.Op Fl u Ar NAME | Fl \-lookup= Ns Ar NAME -.Op Fl v | \-version +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME +.Op Fl r | -raw +.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE +.Op Fl u Ar NAME | Fl -lookup= Ns Ar NAME +.Op Fl v | -version .Sh DESCRIPTION .Nm can be used to lookup and process GNU Name Service names. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME +.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME Write logs to FILENAME. -.It Fl r | \-raw +.It Fl r | -raw No unneeded output. This is a quiet mode where only important information is displayed. For example a lookup for an IP address will only yield the IP address, no descriptive text. -.It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE +.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE Resource Record Type (TYPE) to look for. Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, MX, LEHO, VPN, REV, PTR, TXT. Defaults to "A". -.It Fl u Ar NAME | Fl \-lookup= Ns Ar NAME +.It Fl u Ar NAME | Fl -lookup= Ns Ar NAME Name to lookup. Resolve the specified name using the GNU Name System. -.It Fl T Ar TIMEOUT | Fl \-timeout= Ns Ar TIMEOUT +.It Fl T Ar TIMEOUT | Fl -timeout= Ns Ar TIMEOUT How much time to wait for a resolution to finish. Example: "5s" for 5 seconds or "3m" for 3 minutes. Defaults to "forver" (No timeout). -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .Sh DIAGNOSTICS diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1 index ec1a7ab37..1adfdf4d0 100644 --- a/doc/man/gnunet-identity.1 +++ b/doc/man/gnunet-identity.1 @@ -35,7 +35,7 @@ .Op Fl e Ar NAME | Fl -ego= Ns Ar NAME .Op Fl h | -help .Op Fl m | -monitor -.Op Fl p | \-private-keys +.Op Fl p | -private-keys .Op Fl q | -quiet .Op Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM .Op Fl V | -verbose diff --git a/doc/man/gnunet-namecache.1 b/doc/man/gnunet-namecache.1 index a040622b0..7abd9a449 100644 --- a/doc/man/gnunet-namecache.1 +++ b/doc/man/gnunet-namecache.1 @@ -30,29 +30,29 @@ inspect namecache .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl n Ar NAME | Fl \-name= Ns Ar NAME -.Op Fl v | \-version -.Op Fl z Ar PKEY | Fl \-zone= Ns Ar PKEY +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl n Ar NAME | Fl -name= Ns Ar NAME +.Op Fl v | -version +.Op Fl z Ar PKEY | Fl -zone= Ns Ar PKEY .Sh DESCRIPTION .Nm can be used to inspect values in the namecache. It is passed the mandatory option 'z' ('--zone=') with the argument PKEY, and the mandatory option 'n' ('--name=') with the argument NAME. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl n Ar NAME | Fl \-name= Ns Ar NAME +.It Fl n Ar NAME | Fl -name= Ns Ar NAME Name (label) of the record to display (mandatory option). -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. -.It Fl z Ar PKEY | Fl \-zone= Ns Ar PKEY +.It Fl z Ar PKEY | Fl -zone= Ns Ar PKEY Specifies the public key of the zone to inspect (mandatory option) .El .\".Sh EXAMPLES diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1 index e1a09afe4..ee79a1784 100644 --- a/doc/man/gnunet-namestore-fcfsd.1 +++ b/doc/man/gnunet-namestore-fcfsd.1 @@ -30,11 +30,11 @@ HTTP server for GNU Name System First-Come-First-Served name registration .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl v | \-version -.Op Fl z Ar EGO | \-zone= Ns Ar EGO +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl v | -version +.Op Fl z Ar EGO | -zone= Ns Ar EGO .Sh DESCRIPTION Most users will not want to run an FCFS-zone and thus will not need this program. .Pp @@ -58,16 +58,16 @@ After that, you can start the FCFSD service (possibly using .Pp The options are as follows: .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. -.It Fl z Ar EGO | \-zone= Ns Ar EGO +.It Fl z Ar EGO | -zone= Ns Ar EGO Specifies for which .Ar EGO FCFSD should manage the zone. diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1 index e53bb7d95..e0d68fed1 100644 --- a/doc/man/gnunet-namestore.1 +++ b/doc/man/gnunet-namestore.1 @@ -61,11 +61,11 @@ Desired operation is adding a record. Use the configuration file FILENAME. .It Fl d | -delete Desired operation is deleting records under the given name that match -the specified type (\-t) and value (\-V). +the specified type (-t) and value (-V). If type or value are not specified, it means that all types (or values) should be assumed to match (and possibly multiple or all values under the given label will be deleted). -Specifying a label (\-n) is mandatory. +Specifying a label (-n) is mandatory. Note that matching by expiration time or flags is (currently) not supported. .It Fl D | -display @@ -85,7 +85,7 @@ suggested name for this zone. Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. .It Fl m | -monitor -Monitor changes to the zone on an ongoing basis (in contrast to \-D, +Monitor changes to the zone on an ongoing basis (in contrast to -D, which merely displays the current records). .It Fl n Ar NAME | Fl -name= Ns Ar NAME Label or name of the record to add/delete/display. diff --git a/doc/man/gnunet-nat-auto.1 b/doc/man/gnunet-nat-auto.1 index 2dbfaa599..f6d52abc6 100644 --- a/doc/man/gnunet-nat-auto.1 +++ b/doc/man/gnunet-nat-auto.1 @@ -30,30 +30,30 @@ autoconfigure and test NAT traversal .Sh SYNOPSIS .Nm -.Op Fl a | \-auto -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl S Ar NAME | Fl \-section= Ns Ar NAME -.Op Fl t | \-tcp -.Op Fl u | \-udp -.Op Fl w | \-write +.Op Fl a | -auto +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl S Ar NAME | Fl -section= Ns Ar NAME +.Op Fl t | -tcp +.Op Fl u | -udp +.Op Fl w | -write .Sh DESCRIPTION .Nm allows testing various NAT traversal functions, as well as attempting auto-configuration. The options are as follows: .Bl -tag -width indent -.It Fl a | \-auto +.It Fl a | -auto Attempt auto-configuration for NAT traversal. -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file .Ar FILENAME . -.It Fl S Ar NAME | Fl \-section= Ns Ar NAME +.It Fl S Ar NAME | Fl -section= Ns Ar NAME Name of the configuration section with details about the configuration to test. For example "transport-tcp". -.It Fl t | \-tcp +.It Fl t | -tcp Use TCP. -.It Fl u | \-udp +.It Fl u | -udp Use UDP. -.It Fl w | \-write +.It Fl w | -write Write configuration to configuration file, useful in combination with auto-configuration .Pq Fl a . .El diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1 index 77a5eec26..92ea9fd38 100644 --- a/doc/man/gnunet-nat-server.1 +++ b/doc/man/gnunet-nat-server.1 @@ -30,11 +30,11 @@ help GNUnet setup test network setup with NAT .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl d | \-daemonize -.Op Fl h | \-help -.Op Fl L Ar FILENAME | Fl \-logfile= Ns Ar FILENAME -.Op Fl v | \-version +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl d | -daemonize +.Op Fl h | -help +.Op Fl L Ar FILENAME | Fl -logfile= Ns Ar FILENAME +.Op Fl v | -version .Ao Ar PORT Ac .Sh DESCRIPTION Running a gnunet-nat-server is similar to running a hostlist server: it is a special service to the community with special requirements and no benefit to those running the service. @@ -60,20 +60,20 @@ In fact, distributions are encouraged to consider not shipping it at all. .Pp The options are as follows: .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file .Ar FILENAME . -.It Fl d | \-daemonize +.It Fl d | -daemonize Daemonize gnunet-nat-server (detach from terminal). -.It Fl h | \-help +.It Fl h | -help Print the help page. -.It Fl L Ar LOGLEVEL | Fl \-log= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -log= Ns Ar LOGLEVEL Configure logging to use .Ar LOGLEVEL . -.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME +.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME Configure logging to write logs to .Ar FILENAME . -.It Fl v | \-version +.It Fl v | -version Print the GNUnet version. .El .\".Sh EXAMPLES diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1 index 1ffdc5c7c..f0e36cb29 100644 --- a/doc/man/gnunet-nat.1 +++ b/doc/man/gnunet-nat.1 @@ -30,41 +30,41 @@ interact with the NAT service .Sh SYNOPSIS .Nm -.Op Fl b Ar ADDRESS | Fl \-bind= Ns Ar ADDRESS -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl e Ar ADDRESS | Fl \-external= Ns Ar ADDRESS -.Op Fl i Ar ADDRESS | Fl \-in= Ns Ar ADDRESS -.Op Fl r Ar ADDRESS | Fl \-remote= Ns Ar ADDRESS -.Op Fl S Ar NAME | Fl \-section= Ns Ar NAME -.Op Fl s | \-stun -.Op Fl t | \-tcp -.Op Fl u | \-udp -.Op Fl W | \-watch +.Op Fl b Ar ADDRESS | Fl -bind= Ns Ar ADDRESS +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl e Ar ADDRESS | Fl -external= Ns Ar ADDRESS +.Op Fl i Ar ADDRESS | Fl -in= Ns Ar ADDRESS +.Op Fl r Ar ADDRESS | Fl -remote= Ns Ar ADDRESS +.Op Fl S Ar NAME | Fl -section= Ns Ar NAME +.Op Fl s | -stun +.Op Fl t | -tcp +.Op Fl u | -udp +.Op Fl W | -watch .Sh DESCRIPTION This tool allows testing various NAT traversal functions, as well as attempting auto-configuration. .Sh OPTIONS .Bl -tag -width indent -.It Fl b Ar ADDRESS | Fl \-bind= Ns Ar ADDRESS +.It Fl b Ar ADDRESS | Fl -bind= Ns Ar ADDRESS Assume that the service is (locally) bound to ADDRESS. -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl e Ar ADDRESS | Fl \-external= Ns Ar ADDRESS +.It Fl e Ar ADDRESS | Fl -external= Ns Ar ADDRESS Assume that ADDRESS is the globally visible address of the peer. -.It Fl i Ar ADDRESS | Fl \-in= Ns Ar ADDRESS +.It Fl i Ar ADDRESS | Fl -in= Ns Ar ADDRESS Assuming we are listening at ADDRESS for connection reversal requests. -.It Fl r Ar ADDRESS | Fl \-remote= Ns Ar ADDRESS +.It Fl r Ar ADDRESS | Fl -remote= Ns Ar ADDRESS Ask the peer at ADDRESS for connection reversal, using the local address for the target address of the reversal. -.It Fl S Ar NAME | Fl \-section= Ns Ar NAME +.It Fl S Ar NAME | Fl -section= Ns Ar NAME Name of section in configuration file to use for additional options. -.It Fl s | \-stun +.It Fl s | -stun Enable processing of STUN requests. Will try to read UDP packets from the bind address and handle the packets if they are STUN packets. Will only work with UDP. -.It Fl t | \-tcp +.It Fl t | -tcp Use TCP. -.It Fl u | \-udp +.It Fl u | -udp Use UDP. -.It Fl W | \-watch +.It Fl W | -watch Watch for connection reversal requests. .El .Sh EXAMPLES diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1 index 143295dad..49d059d4f 100644 --- a/doc/man/gnunet-peerinfo.1 +++ b/doc/man/gnunet-peerinfo.1 @@ -30,46 +30,46 @@ display information about other peers .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl g | \-get\-hello -.Op Fl h | \-help -.Op Fl i | \-info -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl l Ar LOGFILE | Fl \-logfile= ns Ar LOGFILE -.Op Fl n | \-numeric -.Op Fl p Ar HELLO | Fl \-put\-hello= Ns Ar HELLO -.Op Fl q | \-quiet -.Op Fl s | \-self -.Op Fl v | \-version +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl g | -get-hello +.Op Fl h | -help +.Op Fl i | -info +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl l Ar LOGFILE | Fl -logfile= ns Ar LOGFILE +.Op Fl n | -numeric +.Op Fl p Ar HELLO | Fl -put-hello= Ns Ar HELLO +.Op Fl q | -quiet +.Op Fl s | -self +.Op Fl v | -version .Sh DESCRIPTION .Nm displays the known addresses and trust of known peers. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Load config file, default FILENAME of the config is .Pa ~/.config/gnunet.conf . -.It Fl g | \-get\-hello +.It Fl g | -get-hello Output HELLO uri(s) -.It Fl h | \-help +.It Fl h | -help Print the help page. -.It Fl i | \-info +.It Fl i | -info List all known peers (and their addresses). -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Set the loglevel -.It Fl l Ar LOGFILE | Fl \-logfile= ns Ar LOGFILE +.It Fl l Ar LOGFILE | Fl -logfile= ns Ar LOGFILE Log messages to LOGFILE -.It Fl n | \-numeric +.It Fl n | -numeric Disable resolution of IPs to hostnames -.It Fl p Ar HELLO | Fl \-put\-hello= Ns Ar HELLO +.It Fl p Ar HELLO | Fl -put-hello= Ns Ar HELLO Add given HELLO uri to the database -.It Fl q | \-quiet +.It Fl q | -quiet Do not print anything but the peer identities -.It Fl s | \-self +.It Fl s | -self Print only our own identity. Together with .Fl q , this is the exact line that other peers would have to put in to their friends file in order to consider this peer one of their friends in F2F mode. -.It Fl v | \-version +.It Fl v | -version Print the version number .El .Sh SEE ALSO diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1 index 04293102c..a54a1717f 100644 --- a/doc/man/gnunet-publish.1 +++ b/doc/man/gnunet-publish.1 @@ -30,25 +30,25 @@ a command line interface for publishing new content into GNUnet .Sh SYNOPSIS .Nm -.Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl D | \-disable\-extractor -.Op Fl E | \-enable\-creation\-time -.Op Fl e | \-extract -.Op Fl h | \-help -.Op Fl k Ar KEYWORD | Fl \-key= Ns Ar KEYWORD -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl m Ar TYPE:VALUE | Fl \-meta= Ns Ar TYPE:VALUE -.Op Fl n | \-noindex -.Op Fl N Ar ID | Fl \-next= Ns Ar ID -.Op Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY -.Op Fl P Ar NAME | Fl \-pseudonym= Ns Ar NAME -.Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL -.Op Fl s | \-simulate-only -.Op Fl t Ar ID | Fl \-this= Ns Ar ID -.Op Fl u Ar URI | Fl \-uri= Ns Ar URI -.Op Fl v | \-version -.Op Fl V | \-verbose +.Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl D | -disable-extractor +.Op Fl E | -enable-creation-time +.Op Fl e | -extract +.Op Fl h | -help +.Op Fl k Ar KEYWORD | Fl -key= Ns Ar KEYWORD +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl m Ar TYPE:VALUE | Fl -meta= Ns Ar TYPE:VALUE +.Op Fl n | -noindex +.Op Fl N Ar ID | Fl -next= Ns Ar ID +.Op Fl p Ar PRIORITY | Fl -prio= Ns Ar PRIORITY +.Op Fl P Ar NAME | Fl -pseudonym= Ns Ar NAME +.Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL +.Op Fl s | -simulate-only +.Op Fl t Ar ID | Fl -this= Ns Ar ID +.Op Fl u Ar URI | Fl -uri= Ns Ar URI +.Op Fl v | -version +.Op Fl V | -verbose .Ao Ar FILENAME Ac .Sh DESCRIPTION In order to share files with other GNUnet users, the files must first be made available to GNUnet. @@ -109,10 +109,10 @@ to specify meta-data. For the .Fl m option you need to use the form keyword-type:value. -For example, use "\-m os:Linux" to specify that the operating system is Linux. +For example, use "-m os:Linux" to specify that the operating system is Linux. Common meta-data types are "author", "title", "mimetype", "filename", "language", "subject" and "keywords". A full list can be obtained from the extract tool using the option -.Fl \-list . +.Fl -list . The meta-data is used to help users in searching for files on the network. The keywords are case-sensitive. .Pp @@ -128,7 +128,7 @@ If you publish or index a file and then leave the network, it will almost always .Pp The options are as follows: .Bl -tag -width indent -.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL +.It Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL This option can be used to specify additional anonymity constraints. The default is 1. If set to 0, GNUnet will publish the file non-anonymously and in fact sign the advertisement for the file using your peer's private key. @@ -143,38 +143,38 @@ The specific numeric value (for anonymity levels above 1) is simple: Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period. The time-period is twice the average delay by which GNUnet artificially delays traffic. Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use alternate config file FILENAME. If this option is not specified, the default is .Pa ~/.config/gnunet.conf . -.It Fl D | \-disable\-extractor +.It Fl D | -disable-extractor Disable use of GNU libextractor for finding additional keywords and metadata. -.It Fl E | \-enable\-creation\-time +.It Fl E | -enable-creation-time Enable use of creation time timestamp in metadata. Setting this information will leak information about the time at which a file was made available. -.It Fl e | \-extract +.It Fl e | -extract Print the list of keywords that will be used for each file given the current options. Do not perform any indexing or publishing. -.It Fl h | \-help +.It Fl h | -help Print the help page. -.It Fl k Ar KEYWORD | Fl \-key= Ns Ar KEYWORD +.It Fl k Ar KEYWORD | Fl -key= Ns Ar KEYWORD Additional key to index the content with (to add multiple keys, specify multiple times). -Each additional key is case\-sensitive. +Each additional key is case-sensitive. Can be specified multiple times. -The keyword is only applied to the top\-level file or directory. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +The keyword is only applied to the top-level file or directory. +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. -.It Fl m Ar TYPE:VALUE | Fl \-meta= Ns Ar TYPE:VALUE +.It Fl m Ar TYPE:VALUE | Fl -meta= Ns Ar TYPE:VALUE For the main file (or directory), set the metadata of the given TYPE to the given VALUE. Note that this will not add the respective VALUE to the set of keywords under which the file can be found. -.It Fl n | \-noindex +.It Fl n | -noindex Executive summary: You probably don't need it. Do not index, full publishing. Note that directories, information for keyword search, namespace search and indexing data are always published (even without this option). With this option, every block of the actual files is stored in encrypted form in the block database of the local peer. While this adds security if the local node is compromised (the adversary snags your machine), it is significantly less efficient compared to on-demand encryption and is definitely not recommended for large files. -.It Fl N Ar ID | Fl \-next= Ns Ar ID +.It Fl N Ar ID | Fl -next= Ns Ar ID Specifies the next identifier of a future version of the file to be published under the same pseudonym. This option is only valid together with the .Fl P @@ -187,36 +187,36 @@ and without .Fl t is not allowed. -.It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY +.It Fl p Ar PRIORITY | Fl -prio= Ns Ar PRIORITY Executive summary: You probably don't need it. Set the priority of the published content (default: 365). If the local database is full, GNUnet will discard the content with the lowest ranking. Note that ranks change over time depending on popularity. The default should be high enough to preserve the locally published content in favor of content that migrates from other peers. -.It Fl P Ar NAME | Fl \-pseudonym= Ns Ar NAME +.It Fl P Ar NAME | Fl -pseudonym= Ns Ar NAME For the top-level directory or file, places the file into the namespace identified by the pseudonym NAME. NAME must be a valid pseudonym managed by .Xr gnunet-identity 1 . -.It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL +.It Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL Set the desired replication level. If CONTENT_PUSHING is set to YES, GNUnet will push each block (for the file) LEVEL times to other peers before doing normal "random" replication of all content. This option can be used to push some content out into the network harder. Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas. -.It Fl s | \-simulate-only -When this option is used, gnunet\-publish will not actually publish the file but just simulate what would be done. +.It Fl s | -simulate-only +When this option is used, gnunet-publish will not actually publish the file but just simulate what would be done. This can be used to compute the GNUnet URI for a file without actually sharing it. -.It Fl t Ar ID | Fl \-this= Ns Ar ID +.It Fl t Ar ID | Fl -this= Ns Ar ID Specifies the identifier under which the file is to be published under a pseudonym. This option is only valid together with the .Fl P option. -.It Fl u Ar URI | Fl \-uri= Ns Ar URI +.It Fl u Ar URI | Fl -uri= Ns Ar URI This option can be used to specify the URI of a file instead of a filename (this is the only case where the otherwise mandatory filename argument must be omitted). Instead of publishing a file or directory and using the corresponding URI, gnunet-publish will use this URI and perform the selected namespace or keyword operations. This can be used to add additional keywords to a file that has already been shared or to add files to a namespace for which the URI is known but the content is not locally available. -.It Fl v | \-version +.It Fl v | -version Print the version number. -.It Fl V | \-verbose +.It Fl V | -verbose Be verbose. Using this option causes gnunet-publish to print progress information and at the end the file identification that can be used to download the file from GNUnet. .El diff --git a/doc/man/gnunet-reclaim.1 b/doc/man/gnunet-reclaim.1 index c1ab0d1aa..5003ef070 100644 --- a/doc/man/gnunet-reclaim.1 +++ b/doc/man/gnunet-reclaim.1 @@ -30,62 +30,62 @@ Command-line tools for re:claimID subsystem .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE -.Op Fl e Ar EGO | Fl \-ego= Ns Ar EGO -.Op Fl a Ar NAME | Fl \-add= Ns Ar NAME -.Op Fl V Ar VALUE | Fl \-value= Ns Ar VALUE -.Op Fl d Ar ID | Fl \-delete= Ns Ar ID -.Op Fl r Ar RP | Fl \-rp= Ns Ar RP -.Op Fl D | \-dump -.Op Fl i Ar A1,A2,... | Fl \-issue= Ns Ar A1,A2,... -.Op Fl C Ar TICKET | Fl \-consume= Ns Ar TICKET -.Op Fl R Ar TICKET | Fl \-revoke= Ns Ar TICKET -.Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE -.Op Fl T | \-tickets -.Op Fl E Ar INTERVAL | Fl \-expiration= Ns Ar INTERVAL -.Op Fl v | \-version +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE +.Op Fl e Ar EGO | Fl -ego= Ns Ar EGO +.Op Fl a Ar NAME | Fl -add= Ns Ar NAME +.Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE +.Op Fl d Ar ID | Fl -delete= Ns Ar ID +.Op Fl r Ar RP | Fl -rp= Ns Ar RP +.Op Fl D | -dump +.Op Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,... +.Op Fl C Ar TICKET | Fl -consume= Ns Ar TICKET +.Op Fl R Ar TICKET | Fl -revoke= Ns Ar TICKET +.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE +.Op Fl T | -tickets +.Op Fl E Ar INTERVAL | Fl -expiration= Ns Ar INTERVAL +.Op Fl v | -version .Sh DESCRIPTION .Nm allows you to manage identity attributes and manage authorizations. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE +.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE Configure logging to write logs to LOGFILE. -.It Fl e Ar EGO | Fl \-ego= Ns Ar EGO +.It Fl e Ar EGO | Fl -ego= Ns Ar EGO Specify identity to use. Always required. -.It Fl a Ar NAME | Fl \-add= Ns Ar NAME +.It Fl a Ar NAME | Fl -add= Ns Ar NAME Add an attribute with NAME. Must be used in conjunction with -V -.It Fl V Ar VALUE | Fl \-value= Ns Ar VALUE +.It Fl V Ar VALUE | Fl -value= Ns Ar VALUE Specify value of attribute to add. -.It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE +.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE Specify type of attribute to add (Default: STRING) -.It Fl d Ar ID | Fl \-delete= Ns Ar ID +.It Fl d Ar ID | Fl -delete= Ns Ar ID Delete an attribute with ID. -.It Fl E Ar INTERVAL | Fl \-expiration= Ns Ar INTERVAL +.It Fl E Ar INTERVAL | Fl -expiration= Ns Ar INTERVAL Specify relative expiration interval (freshness) of attribute. -.It Fl D | \-dump +.It Fl D | -dump List all attributes for given identity. -.It Fl i Ar A1,A2,... | Fl \-issue= Ns Ar A1,A2,... +.It Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,... Authorize a relying party to access a set of attributes. Must be used in conjunction with -r. Returns a TICKET. -.It Fl r Ar RP | Fl \-rp= Ns Ar RP +.It Fl r Ar RP | Fl -rp= Ns Ar RP The relying party to authorize (see -i). RP is a PKEY of the entity. -.It Fl C Ar TICKET | Fl \-consume= Ns Ar TICKET +.It Fl C Ar TICKET | Fl -consume= Ns Ar TICKET Consume TICKET and retrieve shared attributes. To be used by RP. -.It Fl R Ar TICKET | Fl \-revoke= Ns Ar TICKET +.It Fl R Ar TICKET | Fl -revoke= Ns Ar TICKET Revoke TICKET. To be used by identity which issued TICKET. -.It Fl T | \-tickets +.It Fl T | -tickets List issued tickets. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .\".Sh EXAMPLES diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-resolver.1 index 843b4e2a0..8952dc14e 100644 --- a/doc/man/gnunet-resolver.1 +++ b/doc/man/gnunet-resolver.1 @@ -30,29 +30,29 @@ built-in GNUnet stub resolver .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE -.Op Fl r | \-reverse -.Op Fl v | \-version +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE +.Op Fl r | -reverse +.Op Fl v | -version .Ao Ar hostname Ac .Sh DESCRIPTION .Nm allows you to use the build-in GNUnet stub resolver. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE +.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE Configure logging to write logs to LOGFILE. -.It Fl r | \-reverse +.It Fl r | -reverse Perform a reverse lookup. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .\".Sh EXAMPLES diff --git a/doc/man/gnunet-revocation.1 b/doc/man/gnunet-revocation.1 index 16f954a2e..812c2633e 100644 --- a/doc/man/gnunet-revocation.1 +++ b/doc/man/gnunet-revocation.1 @@ -30,14 +30,14 @@ revoke private keys (of egos) in GNUnet .Sh SYNOPSIS .Nm -.Op Fl t Ar KEY | Fl \-test= Ns Ar KEY -.Op Fl R Ar NAME | Fl \-revoke= Ns Ar NAME -.Op Fl p | \-perform -.Op Fl f Ar NAME | Fl \-filename= Ns Ar NAME -.Op Fl c Ar FILENAME, Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl v | \-version +.Op Fl t Ar KEY | Fl -test= Ns Ar KEY +.Op Fl R Ar NAME | Fl -revoke= Ns Ar NAME +.Op Fl p | -perform +.Op Fl f Ar NAME | Fl -filename= Ns Ar NAME +.Op Fl c Ar FILENAME, Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl v | -version .Sh DESCRIPTION .Nm can be used to verify if a key has been revoked, to create a revocation certificate for later revocation, to instantly revoke a key and to use a pre-generated revocation certificate to revoke a key. @@ -49,26 +49,26 @@ gnunet-revocation also makes is possible to resume the pre-calculation of a revo Note that performing a revocation proof-of-work is deliberately VERY expensive. Depending on your CPU, the calculation can take days or weeks. .Bl -tag -width indent -.It Fl t Ar KEY | Fl \-test= Ns Ar KEY -Check if the given KEY (ASCII\-encoded public key required) has been revoked. -.It Fl R Ar NAME | Fl \-revoke= Ns Ar NAME +.It Fl t Ar KEY | Fl -test= Ns Ar KEY +Check if the given KEY (ASCII-encoded public key required) has been revoked. +.It Fl R Ar NAME | Fl -revoke= Ns Ar NAME Calculate or perform revocation for the ego with the given NAME. -.It Fl p | \-perform +.It Fl p | -perform Actually perform the revocation as soon as possible (do not just generate a revocation certificate, use it). Must be supplied to actually perform the revocation. -.It Fl f Ar NAME | Fl \-filename= Ns Ar NAME +.It Fl f Ar NAME | Fl -filename= Ns Ar NAME Use NAME as the name of the file that is to contain the revocation certificate. Intermediate computation results will be stored here, as well as the final revocation certificate. -When used together with \-p, this file will be inspected to see if it contains a valid certificate for instant revocation, in which case the revocation can be performed instantly. -If the given file contains anything (a valid certificate, with or without the completed proof-of-work) there is no need to supply the "\-R" option or to still have the private key of the ego to perform the revocation. -.It Fl c Ar FILENAME, Fl \-config= Ns Ar FILENAME +When used together with -p, this file will be inspected to see if it contains a valid certificate for instant revocation, in which case the revocation can be performed instantly. +If the given file contains anything (a valid certificate, with or without the completed proof-of-work) there is no need to supply the "-R" option or to still have the private key of the ego to perform the revocation. +.It Fl c Ar FILENAME, Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .Sh SEE ALSO diff --git a/doc/man/gnunet-scrypt.1 b/doc/man/gnunet-scrypt.1 index 16a377443..ab1188348 100644 --- a/doc/man/gnunet-scrypt.1 +++ b/doc/man/gnunet-scrypt.1 @@ -29,41 +29,41 @@ .Nd manipulate GNUnet proof of work files .Sh SYNOPSIS .Nm -.Op Fl b Ar BITS | Fl \-bits= Ns Ar BITS -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl k Ar FILENAME | Fl \-keyfile= Ns Ar FILENAME -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME -.Op Fl o Ar FILENAME | Fl \-outfile= Ns Ar FILENAME -.Op Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY -.Op Fl v | \-version +.Op Fl b Ar BITS | Fl -bits= Ns Ar BITS +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl k Ar FILENAME | Fl -keyfile= Ns Ar FILENAME +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME +.Op Fl o Ar FILENAME | Fl -outfile= Ns Ar FILENAME +.Op Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY +.Op Fl v | -version .Sh DESCRIPTION .Nm is a command line tool to manipulate GNUnet proof of work files. .Bl -tag -width indent -.It Fl b Ar BITS | Fl \-bits= Ns Ar BITS +.It Fl b Ar BITS | Fl -bits= Ns Ar BITS Number of bits to require for the proof of work. -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file .Ar FILENAME . -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl k Ar FILENAME | Fl \-keyfile= Ns Ar FILENAME +.It Fl k Ar FILENAME | Fl -keyfile= Ns Ar FILENAME Use .Ar FILENAME as the file with private key, otherwise the default private key file is used. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME +.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME Configure logging to write logs to FILENAME. -.It Fl o Ar FILENAME | Fl \-outfile= Ns Ar FILENAME +.It Fl o Ar FILENAME | Fl -outfile= Ns Ar FILENAME File with proof of work, otherwise default is used. -.It Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY +.It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY Time to wait between calculations. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .Sh SEE ALSO The full documentation for gnunet is maintained as a Texinfo manual. diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1 index 59263c1b1..c670da3d2 100644 --- a/doc/man/gnunet-search.1 +++ b/doc/man/gnunet-search.1 @@ -30,17 +30,17 @@ a command line interface to search for content on GNUnet .Sh SYNOPSIS .Nm -.Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME -.Op Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME -.Op Fl n | \-no-network -.Op Fl N Ar VALUE | Fl \-results= Ns Ar VALUE -.Op Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY -.Op Fl v | \-version -.Op Fl V | \-verbose +.Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME +.Op Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME +.Op Fl n | -no-network +.Op Fl N Ar VALUE | Fl -results= Ns Ar VALUE +.Op Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY +.Op Fl v | -version +.Op Fl V | -verbose .Ao KEYWORD Ac Ao +KEYWORD Ac | Ao Ar URI Ac Ao Ar +URI Ac .Sh DESCRIPTION Search for content on GNUnet. @@ -49,7 +49,7 @@ The keywords are case-sensitive. can be used both for a search in the global namespace as well as for searching a private subspace. The options are as follows: .Bl -tag -width indent -.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL +.It Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL This option can be used to specify additional anonymity constraints. The default is 1. If set to 0, GNUnet will publish the file non-anonymously and in fact sign the advertisement for the file using your peer's private key. @@ -64,37 +64,37 @@ The specific numeric value (for anonymity levels above 1) is simple: Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period. The time-period is twice the average delay by which GNUnet artificially delays traffic. Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file .Ar FILENAME (default: .Pa ~/.config/gnunet.conf ) -.It Fl h | \-help +.It Fl h | -help Print the help page. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. -.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME +.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME Write logs to .Ar FILENAME . -.It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME +.It Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME Writes a GNUnet directory containing all of the search results to .Ar FILENAME . -.It Fl n | \-no-network +.It Fl n | -no-network Only search locally, do not forward requests to other peers. -.It Fl N Ar VALUE | Fl \-results= Ns Ar VALUE +.It Fl N Ar VALUE | Fl -results= Ns Ar VALUE Automatically terminate the search after receiving .Ar VALUE results. -.It Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY +.It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY Automatically timeout search after .Ar DELAY . The value given must be a number followed by a space and a time unit, for example "500 ms". Note that the quotes are required on the shell. -Otherwise the search runs until gnunet-search is aborted with CTRL\-C. -.It Fl v | \-version +Otherwise the search runs until gnunet-search is aborted with CTRL-C. +.It Fl v | -version print the version number -.It Fl V | \-verbose +.It Fl V | -verbose print meta data from search results as well .El You can run gnunet-search with an URI instead of a keyword. diff --git a/doc/man/gnunet-statistics.1 b/doc/man/gnunet-statistics.1 index a2ada90a4..b745c9897 100644 --- a/doc/man/gnunet-statistics.1 +++ b/doc/man/gnunet-statistics.1 @@ -29,61 +29,61 @@ .Nd display statistics about your GNUnet system .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME -.Op Fl n Ar NAME | Fl \-name= Ns Ar NAME -.Op Fl o Ar PORT | Fl \-port= Ns Ar PORT -.Op Fl p | \-persistent -.Op Fl q | \-quiet -.Op Fl r Ar REMOTE | Fl \-remote= Ns Ar REMOTE -.Op Fl S Ar SEPARATOR | Fl \-csv-separator= Ns Ar SEPARATOR -.Op Fl s Ar SUBSYSTEM | Fl \-subsystem= Ns Ar SUBSYSTEM -.Op Fl t Ar PATH | Fl \-testbed= Ns Ar PATH -.Op Fl v | \-version -.Op Fl w | \-watch +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME +.Op Fl n Ar NAME | Fl -name= Ns Ar NAME +.Op Fl o Ar PORT | Fl -port= Ns Ar PORT +.Op Fl p | -persistent +.Op Fl q | -quiet +.Op Fl r Ar REMOTE | Fl -remote= Ns Ar REMOTE +.Op Fl S Ar SEPARATOR | Fl -csv-separator= Ns Ar SEPARATOR +.Op Fl s Ar SUBSYSTEM | Fl -subsystem= Ns Ar SUBSYSTEM +.Op Fl t Ar PATH | Fl -testbed= Ns Ar PATH +.Op Fl v | -version +.Op Fl w | -watch .Ao Ar VALUE Ac .Sh DESCRIPTION .Nm is used to display detailed information about various aspect of GNUnet's operation. This tool only works if the "statistics" service is available. -gnunet-statistics can be used to set a value by giving the options \-n, \-s and also a VALUE. +gnunet-statistics can be used to set a value by giving the options -n, -s and also a VALUE. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME +.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME Configure logging to write logs to FILENAME -.It Fl n Ar NAME | Fl \-name= Ns Ar NAME +.It Fl n Ar NAME | Fl -name= Ns Ar NAME Each statistic has a NAME that is unique with in its subsystem. With this option, the output can be restricted to statistics that have a particular NAME. -.It Fl o Ar PORT | Fl \-port= Ns Ar PORT +.It Fl o Ar PORT | Fl -port= Ns Ar PORT PORT for remote host -.It Fl p | \-persistent +.It Fl p | -persistent When setting a value, make the value persistent. If the value used to be persistent and this flag is not given, it will be marked as non-persistent. -.It Fl q | \-quiet +.It Fl q | -quiet Just print the statistics value -.It Fl r Ar REMOTE | Fl \-remote= Ns Ar REMOTE +.It Fl r Ar REMOTE | Fl -remote= Ns Ar REMOTE Connect to a remote host given as REMOTE. -.It Fl S Ar SEPARATOR | Fl \-csv-separator= Ns Ar SEPARATOR +.It Fl S Ar SEPARATOR | Fl -csv-separator= Ns Ar SEPARATOR Specify a separator for generating csv-output. -.It Fl s Ar SUBSYSTEM | Fl \-subsystem= Ns Ar SUBSYSTEM +.It Fl s Ar SUBSYSTEM | Fl -subsystem= Ns Ar SUBSYSTEM Statistics are kept for various subsystems. With this option, the output can be restricted to a particular subsystem only. -.It Fl t Ar PATH | Fl \-testbed= Ns Ar PATH +.It Fl t Ar PATH | Fl -testbed= Ns Ar PATH When running testbed, you can get statistics of all peers with specefying the folder containing the data of all testbed nodes like .Pp .Dl $ gnunet-statistics -t /tmp/testbedARtmQv .Pp -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. -.It Fl w | \-watch +.It Fl w | -watch Watch value continuously. .El .Sh SEE ALSO diff --git a/doc/man/gnunet-testbed-profiler.1 b/doc/man/gnunet-testbed-profiler.1 index 475884df2..5d1737e72 100644 --- a/doc/man/gnunet-testbed-profiler.1 +++ b/doc/man/gnunet-testbed-profiler.1 @@ -30,38 +30,38 @@ profiling driver for the testbed .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl e Ar COUNT | Fl \-num-errors= Ns Ar COUNT -.Op Fl H Ar FILENAME | Fl \-hosts= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE -.Op Fl n | \-non-interactive -.Op Fl p Ar COUNT | Fl \-num-peers= Ns Ar COUNT -.Op Fl v | \-version +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl e Ar COUNT | Fl -num-errors= Ns Ar COUNT +.Op Fl H Ar FILENAME | Fl -hosts= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE +.Op Fl n | -non-interactive +.Op Fl p Ar COUNT | Fl -num-peers= Ns Ar COUNT +.Op Fl v | -version .Sh DESCRIPTION .Nm is a command line profiling driver for the testbed. .Sh OPTIONS .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl e Ar COUNT | Fl \-num-errors= Ns Ar COUNT +.It Fl e Ar COUNT | Fl -num-errors= Ns Ar COUNT Tolerate COUNT number of continious timeout failures. -.It Fl H Ar FILENAME | Fl \-hosts= Ns Ar FILENAME +.It Fl H Ar FILENAME | Fl -hosts= Ns Ar FILENAME Name of the file with the login information for the testbed. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE +.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE Configure logging to write logs to LOGFILE. -.It Fl n | \-non-interactive +.It Fl n | -non-interactive Run profiler in non-interactive mode where upon testbed setup the profiler does not wait for a keystroke but continues to run until a termination signal is received. -.It Fl p Ar COUNT | Fl \-num-peers= Ns Ar COUNT +.It Fl p Ar COUNT | Fl -num-peers= Ns Ar COUNT Create COUNT number of peers. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .Sh SEE ALSO diff --git a/doc/man/gnunet-testing-run-service.1 b/doc/man/gnunet-testing-run-service.1 index 4f3c5c74b..5aa13fd22 100644 --- a/doc/man/gnunet-testing-run-service.1 +++ b/doc/man/gnunet-testing-run-service.1 @@ -30,9 +30,9 @@ command line tool to start a service for testing .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl s Ar SERVICE | Fl \-service= Ns Ar SERVICE +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl s Ar SERVICE | Fl -service= Ns Ar SERVICE .Sh DESCRIPTION .Nm is a command line tool to start a service for testing. @@ -43,11 +43,11 @@ When reading the character 'r' from stdin, the running service is restarted with .Pp This executable is intended to be used by gnunet-java, in order to reliably start and stop services for test cases. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Name of the template configuration file to use (optional). -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl s Ar SERVICE | Fl \-service= Ns Ar SERVICE +.It Fl s Ar SERVICE | Fl -service= Ns Ar SERVICE Name of the service to run. .El .Sh SEE ALSO diff --git a/doc/man/gnunet-testing.1 b/doc/man/gnunet-testing.1 index 659e46fbc..c1dad78e0 100644 --- a/doc/man/gnunet-testing.1 +++ b/doc/man/gnunet-testing.1 @@ -30,43 +30,43 @@ command line tool to access the testing library .Sh SYNOPSIS .Nm -.Op Fl C | \-cfg -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl H | \-hostkeys -.Op Fl h | \-help -.Op Fl k | \-key -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOFILE -.Op Fl n | \-number -.Op Fl t | \-template -.Op Fl v | \-version +.Op Fl C | -cfg +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl H | -hostkeys +.Op Fl h | -help +.Op Fl k | -key +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOFILE +.Op Fl n | -number +.Op Fl t | -template +.Op Fl v | -version .Sh DESCRIPTION .Nm is a command line tool to access the testing library. .Sh OPTIONS .Bl -tag -width indent -.It Fl C | \-cfg +.It Fl C | -cfg Create unique configuration files. -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file .Ar FILENAME . -.It Fl H | \-hostkeys +.It Fl H | -hostkeys Host key file. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl k | \-key +.It Fl k | -key Create hostkey files from pre-computed hostkey list. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOFILE +.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOFILE Configure logging to write logs to .Ar LOGFILE . -.It Fl n | \-number +.It Fl n | -number Number of unique configuration files or hostkeys to create. -.It Fl t | \-template +.It Fl t | -template Configuration template. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .Sh SEE ALSO diff --git a/doc/man/gnunet-unindex.1 b/doc/man/gnunet-unindex.1 index 886793ed9..36d59edf0 100644 --- a/doc/man/gnunet-unindex.1 +++ b/doc/man/gnunet-unindex.1 @@ -30,27 +30,27 @@ a command line interface for deleting indexed files from GNUnet .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl v | \-version -.Op Fl V | \-verbose +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl v | -version +.Op Fl V | -verbose FILENAME .Sh DESCRIPTION .Nm is used for deleting indexed files from GNUnet. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use config file FILENAME as config (default: .Pa ~/.config/gnunet.conf Ns ). -.It Fl h | \-help +.It Fl h | -help Print the help page. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Change the loglevel. Possible values for LOGLEVEL are NOTHING, ERROR, WARNING, INFO and DEBUG. -.It Fl v | \-version +.It Fl v | -version Print the version number. -.It Fl V | \-verbose +.It Fl V | -verbose Be verbose. .El .Sh NOTES diff --git a/doc/man/gnunet-uri.1 b/doc/man/gnunet-uri.1 index 1d8380631..38b901697 100644 --- a/doc/man/gnunet-uri.1 +++ b/doc/man/gnunet-uri.1 @@ -29,11 +29,11 @@ .Nd invoke default handler for GNUnet URIs .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl l | \-logfile= Ns Ar FILENAME -.Op Fl v | \-version +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl l | -logfile= Ns Ar FILENAME +.Op Fl v | -version URI .Sh DESCRIPTION .Nm @@ -43,17 +43,17 @@ thus the specific tool to handle the URI depends on the subsystem. gnunet-uri will determine the correct tool (by looking for SUBSYSTEM in the configuration section "uri") and invoke it. .Bl -tag -width indent -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl l | \-logfile= Ns Ar FILENAME +.It Fl l | -logfile= Ns Ar FILENAME Configure logging to write logs to .Ar FILENAME . -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .Sh SEE ALSO diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1 index 477358f22..210476b79 100644 --- a/doc/man/gnunet-vpn.1 +++ b/doc/man/gnunet-vpn.1 @@ -29,19 +29,19 @@ .Nd manually setup a GNUnet VPN tunnel .Sh SYNOPSIS .Nm -.Op Fl 4 | \-ipv4 -.Op Fl 6 | \-ipv6 -.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME -.Op Fl d Ar TIME | Fl \-duration Ar TIME -.Op Fl h | \-help -.Op Fl i Ar IP | Fl \-ip Ar IP -.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL -.Op Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID -.Op Fl s Ar NAME | Fl \-service= Ns Ar NAME -.Op Fl t | \-tcp -.Op Fl u | \-udp -.Op Fl V | \-verbose -.Op Fl v | \-version +.Op Fl 4 | -ipv4 +.Op Fl 6 | -ipv6 +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl d Ar TIME | Fl -duration Ar TIME +.Op Fl h | -help +.Op Fl i Ar IP | Fl -ip Ar IP +.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL +.Op Fl p Ar PEERID | Fl -peer= Ns Ar PEERID +.Op Fl s Ar NAME | Fl -service= Ns Ar NAME +.Op Fl t | -tcp +.Op Fl u | -udp +.Op Fl V | -verbose +.Op Fl v | -version .Sh DESCRIPTION .Nm can be used to manually setup a VPN tunnel via the GNUnet network. @@ -70,41 +70,41 @@ The address can be displayed as soon as it has been allocated, or only after .Pq Fl a the tunnel has been created. .Bl -tag -width indent -.It Fl 4 | \-ipv4 +.It Fl 4 | -ipv4 Desired IP address on this end of the tunnel should be an IPv4 address. -.It Fl 6 | \-ipv6 +.It Fl 6 | -ipv6 Desired IP address on this end of the tunnel should be an IPv6 address. -.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl d Ar TIME | Fl \-duration Ar TIME +.It Fl d Ar TIME | Fl -duration Ar TIME The mapping should be established for TIME. The value given must be a number followed by a space and a time unit, for example "500 ms". Note that the quotes are required on the shell. The default vaue is 5 minutes. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl i Ar IP | Fl \-ip Ar IP +.It Fl i Ar IP | Fl -ip Ar IP Tunnel should be to an exit node and connect to the given IPv4 or IPv6 IP address. Note that you can specify an IPv6 address as the target here, even in -combination with "\-4" (4to6) and similarly you can specify an IPv4 -address in combination with "\-6" (6to4). -.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +combination with "-4" (4to6) and similarly you can specify an IPv4 +address in combination with "-6" (6to4). +.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -.It Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID +.It Fl p Ar PEERID | Fl -peer= Ns Ar PEERID Name of the peer offering the service to connect to. Cannot be used in conjunction with .Fl i , requires .Fl s . -.It Fl s Ar NAME | Fl \-service= Ns Ar NAME +.It Fl s Ar NAME | Fl -service= Ns Ar NAME Name of the service running on the target peer. Cannot be used in conjunction with .Fl i , requires .Fl p . -.It Fl t | \-tcp +.It Fl t | -tcp Service runs TCP. Either .Fl t @@ -112,7 +112,7 @@ or .Fl u must be specified when using .Fl s . -.It Fl u | \-udp +.It Fl u | -udp Service runs UDP. Either .Fl t @@ -120,9 +120,9 @@ or .Fl u must be specified when using .Fl s . -.It Fl V | \-verbose +.It Fl V | -verbose Be verbose. -.It Fl v | \-version +.It Fl v | -version Print GNUnet version number. .El .Sh SEE ALSO diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1 index f09544912..f3f60bfb4 100644 --- a/doc/man/gnunet-zoneimport.1 +++ b/doc/man/gnunet-zoneimport.1 @@ -30,11 +30,11 @@ import DNS zone into GNS zone .Sh SYNOPSIS .Nm -.Op Fl c Ar FILENAME | \-config= Ns Ar FILENAME -.Op Fl h | \-help -.Op Fl m Ar RELATIVETIME | Fl \-minimum-expiration= Ns Ar RELATIVETIME -.Op Fl s Ar MAPSIZE | Fl \-size= Ns Ar MAPSIZE -.Op Ar \IP +.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME +.Op Fl h | -help +.Op Fl m Ar RELATIVETIME | Fl -minimum-expiration= Ns Ar RELATIVETIME +.Op Fl s Ar MAPSIZE | Fl -size= Ns Ar MAPSIZE +.Ao Ar IP Ac .Sh DESCRIPTION .Nm reads a list of domain names (FQDN) from stdin and issues DNS queries for each of the domain names given. @@ -56,27 +56,27 @@ Thus, it is fine to restart gnunet-zoneimport whenever the list of domain names Finally, gnunet-zoneimport keeps information for each domain name in memory. This consumes about 200 bytes per domain name, or 1 GB for 5 million labels. .Bl -tag -width indent -.It Fl c Ar FILENAME | \-config= Ns Ar FILENAME +.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. -.It Fl h | \-help +.It Fl h | -help Print short help on options. -.It Fl m Ar RELATIVETIME | Fl \-minimum-expiration= Ns Ar RELATIVETIME +.It Fl m Ar RELATIVETIME | Fl -minimum-expiration= Ns Ar RELATIVETIME Ensure that imported DNS records never have an expiration time that is less than RELATIVETIME into the future. RELATIVETIME is a time given like "1 week" or "1 h". -If DNS returns records with a shorter lifetime, gnunet\-zoneimport will simply bump the lifetime to the specified value (relative to the time of the import). +If DNS returns records with a shorter lifetime, gnunet-zoneimport will simply bump the lifetime to the specified value (relative to the time of the import). Default is zero. -.It Fl s Ar MAPSIZE | Fl \-size= Ns Ar MAPSIZE +.It Fl s Ar MAPSIZE | Fl -size= Ns Ar MAPSIZE Specifies the size (in number of entries) to use for the main hash map. The value provided should be at least twice the number of domain names that will be given to the tool. This option is required for very large zones where the number of records encountered is too large for the automatic growth mechanism to work (that one is limited to at most 16 MB allocations for security reasons). Do not worry about this unless you are importing millions of domain names from a zone. -.It Ar \IP +.It Ao Ar IP Ac IP Is the list of IPs given. .El .Sh EXAMPLES -Typical invocaton would be: +Typical invocation would be: .Pp -.Dl $ gnunet\-zoneimport 1.2.3.4 < names.txt +.Dl $ gnunet-zoneimport 1.2.3.4 < names.txt .Sh SEE ALSO .Xr gnunet-gns 1 , .Xr gnunet-namestore 1