summaryrefslogtreecommitdiff
path: root/doc/man/gnunet-auto-share.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-auto-share.1')
-rw-r--r--doc/man/gnunet-auto-share.1232
1 files changed, 116 insertions, 116 deletions
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1
index a2965b19f..00b627d87 100644
--- a/doc/man/gnunet-auto-share.1
+++ b/doc/man/gnunet-auto-share.1
@@ -1,126 +1,126 @@
-.TH GNUNET\-AUTO\-SHARE "1" "June 18, 2012" "GNUnet"
-.SH NAME
-gnunet\-auto\-share \- a command line tool to automatically share an
-entire directory with other users
-.SH SYNOPSIS
-.B gnunet\-auto\-share
-[\fIOPTIONS\fR] DIRNAME
-.SH DESCRIPTION
-In order to share files with other GNUnet users, the files must first be made
-available to GNUnet. This tool can be used to automatically share all files
-from a certain directory. The program will periodically scan the directory
-for changes and publish files that are new or that changed on GNUnet.
-Which files have already been shared is remembered in a ".auto-share" file
-in the shared directory. You can run the tool by hand or automatically by
-adding the respective options to your configuration. gnunet\-auto\-share
-has many options in common with gnunet\-publish, but can only be used to
-index files.
-.PP
+.Dd June 18, 2012
+.Dt GNUNET-AUTO-SHARE 1
+.Os
+.Sh NAME
+.Nm gnunet-auto-share
+.Nd
+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
+.Ao Ar DIRNAME Ac
+.Sh DESCRIPTION
+In order to share files with other GNUnet users, the files must first be made available to GNUnet.
+This tool can be used to automatically share all files from a certain directory.
+The program will periodically scan the directory for changes and publish files that are new or that changed on GNUnet.
+Which files have already been shared is remembered in a ".auto-share" file in the shared directory.
+You can run the tool by hand or automatically by adding the respective options to your configuration.
+gnunet\-auto\-share has many options in common with gnunet\-publish, but can only be used to index files.
+.Pp
You can use automatic meta\-data extraction (based on libextractor).
-.TP
-\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
-Use alternate config file (if this option is not specified, the
-default is ~/.config/gnunet.conf).
-.TP
-\fB\-D\fR, \fB\-\-disable\-extractor\fR
+.Bl -tag -width Ds
+.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
+The \fB\-a\fR option can be used to specify additional anonymity constraints.
+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.
+This will allow other users to download the file as fast as possible, including using non-anonymous methods (DHT, direct transfer).
+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 infer data about your identity.
+You can gain better privacy by specifying a higher level of anonymity, which increases the amount of cover traffic your own traffic will get, at the expense of performance.
+Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
+.Pp
+The definition of the ANONYMITY LEVEL is the following.
+0 means no anonymity is required.
+Otherwise a value of 'v' means that 1 out of v bytes of "anonymous" traffic can be from the local user, leaving 'v-1' bytes of cover traffic per byte on the wire.
+Thus, if GNUnet routes n bytes of messages from foreign peers (using anonymous routing), it may originate n/(v-1) bytes of data in the same time\-period.
+The time\-period is twice the average delay that GNUnet defers forwarded queries.
+.Pp
+The default is 1 and this should be fine for most users.
+Also notice that if you choose very large values, you may end up having no throughput at all, especially if many of your fellow GNUnet\-peers all do the same.
+.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+Use alternate config file (if this option is not specified, the default is ~/.config/gnunet.conf).
+.It Fl D | \-disable-extractor
Disable use of GNU libextractor for finding additional keywords and metadata.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
+.It Fl d | \-disable-creation-time
+Disable adding the creation time to the metadata of the uploaded file.
+.It Fl h | \-help
Print a brief help page with all the options.
-.TP
-\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
-Change the loglevel. Possible values for LOGLEVEL are
-ERROR, WARNING, INFO and DEBUG.
-.TP
-\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR
+.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
+Configure logging to write logs to FILENAME.
+.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.
-.TP
-\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR
-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.
-.TP
-\fB\-v\fR, \fB\-\-version\fR
+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
+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
+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
Print the version number.
-.TP
-\fB\-V\fR, \fB\-\-verbose\fR
-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.
-.SH SETTING ANONYMITY LEVEL
-The \fB\-a\fR option can be used to specify additional anonymity constraints.
-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. This will
-allow other users to download the file as fast as possible, including using
-non-anonymous methods (DHT, direct transfer). 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 infer data about your
-identity. You can gain better privacy by specifying a higher level of
-anonymity, which increases the amount of cover traffic your own traffic will
-get, at the expense of performance. Note that regardless of the anonymity
-level you choose, peers that cache content in the network always use anonymity
-level 1.
-.PP
-The definition of the ANONYMITY LEVEL is the following. 0 means no anonymity
-is required. Otherwise a value of 'v' means that 1 out of v bytes of "anonymous"
-traffic can be from the local user, leaving 'v-1' bytes of cover traffic per
-byte on the wire. Thus, if GNUnet routes n bytes of messages from foreign
-peers (using anonymous routing), it may originate n/(v-1) bytes of data in
-the same time\-period. The time\-period is twice the average delay that
-GNUnet defers forwarded queries.
-.PP
-The default is 1 and this should be fine for most users. Also notice that if
-you choose very large values, you may end up having no throughput at all,
-especially if many of your fellow GNUnet\-peers all do the same.
-.SH EXAMPLES
-\fBBasic example\fR
-.TP
-# gnunet\-auto\-share $HOME/gnunet\-share/ &
-Share a directory "$HOME/gnunet\-share/"
-.PP
-\fBBasic configuration\fR
-.PP
-Share a directory "$HOME/gnunet\-share/":
-
- [gnunet-auto-share]
- OPTIONS = $HOME/gnunet\-share
- IMMEDIATE_START = YES # start this service when the peer starts
-.SH FILES
+.El
+.Sh EXAMPLES
+.Ss Basic example
+$ gnunet-auto-share $HOME/gnunet-share/ &
+.Pp
+Share a directory "$HOME/gnunet-share/"
+.Ss Basic configuration
+$ Share a directory "$HOME/gnunet-share/":
+.Pp
+.Bd -literal -offset indent -compact
+[gnunet-auto-share]
+OPTIONS = $HOME/gnunet-share
+IMMEDIATE_START = YES # start this service when the peer starts
+.Ed
+.Sh FILES
.TP
~/.config/gnunet.conf
GNUnet configuration file
-.SH BUGS
-Report bugs to <https://bugs.gnunet.org/> or by sending electronic
-mail to <gnunet\-developers@gnu.org>
-.SH SEE ALSO
-\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
-\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1),
-\fBgnunet.conf\fP(5), \fBextract\fP(1)
-The full documentation for
-.B gnunet
-is maintained as a Texinfo manual. If the
-.B info
-and
-.B gnunet
-programs are properly installed at your site, the command
-.IP
-.B info gnunet
-.PP
+.Sh SEE ALSO
+.Xr gnunet-fs-gtk 1 ,
+.Xr gnunet-publish 1 ,
+.Xr gnunet-search 1 ,
+.Xr gnunet-download 1 ,
+.Xr gnunet.conf 5 ,
+.Xr extract 1
+.sp
+The full documentation for gnunet is maintained as a Texinfo manual.
+If the
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.Pp
should give you access to the complete handbook,
-.IP
-.B info gnunet-c-tutorial
-.PP
+.Pp
+.Dl info gnunet-c-tutorial
+.Pp
will give you access to a tutorial for developers.
-.PP
-Depending on your installation, this information is also
-available in
-\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
+.sp
+Depending on your installation, this information is also available in
+.Xr gnunet 7 and
+.Xr gnunet-c-tutorial 7 .
+.\".Sh HISTORY
+.\".Sh AUTHORS
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt gnunet-developers@gnu.org .