[GNUnet-SVN] r22081 - in gnunet: doc/man src/fs src/include

[gnunet]

Author: grothoff
Date: 2012-06-18 17:00:12 +0200 (Mon, 18 Jun 2012)
New Revision: 22081

Added:
   gnunet/doc/man/gnunet-auto-share.1
Modified:
   gnunet/doc/man/Makefile.am
   gnunet/doc/man/gnunet-publish.1
   gnunet/src/fs/fs.conf.in
   gnunet/src/include/gnunet_scheduler_lib.h
Log:
adding man page for gnunet-auto-share, updating man page for gnunet-publish

Modified: gnunet/doc/man/Makefile.am
===================================================================
--- gnunet/doc/man/Makefile.am  2012-06-18 14:50:33 UTC (rev 22080)
+++ gnunet/doc/man/Makefile.am  2012-06-18 15:00:12 UTC (rev 22081)
@@ -1,5 +1,6 @@
 man_MANS = \
   gnunet-arm.1 \
+  gnunet-auto-share.1 \
   gnunet-core.1 \
   gnunet-directory.1 \
   gnunet-download.1 \

Added: gnunet/doc/man/gnunet-auto-share.1
===================================================================
--- gnunet/doc/man/gnunet-auto-share.1                          (rev 0)
+++ gnunet/doc/man/gnunet-auto-share.1  2012-06-18 15:00:12 UTC (rev 22081)
@@ -0,0 +1,86 @@
+.TH GNUNET\-AUTO\-SHARE "1" "18 Jun 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
+.PP
+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).
+.PP
+
+\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
+Use alternate config file (if this option is not specified, the default is 
~/.gnunet/gnunet.conf).
+
+.TP
+\fB\-D\fR, \fB\-\-disable\-extractor\fR 
+Disable use of GNU libextractor for finding additional keywords and metadata.
+
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+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
+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
+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.  
+
+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. 
+
+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
+.PP
+
+\fBBasic example\fR
+
+Share a directory "$HOME/gnunet\-share/":
+
+ # gnunet\-auto\-share $HOME/gnunet\-share/ &
+
+
+\fBBasic configuration\fR
+
+Share a directory "$HOME/gnunet\-share/":
+
+ [ARM]
+ DEFAULTSERVICES = gnunet-auto-share # other default services here
+
+ [gnunet-auto-share]
+ OPTIONS = $HOME/gnunet\-share
+
+
+.SH FILES
+.TP
+~/.gnunet/gnunet.conf
+GNUnet configuration file
+.SH "REPORTING BUGS"
+Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to 
<address@hidden>
+.SH "SEE ALSO"
+\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-pseudonym\fP(1), \fBgnunet\-search\fP(1), 
\fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1)

Modified: gnunet/doc/man/gnunet-publish.1
===================================================================
--- gnunet/doc/man/gnunet-publish.1     2012-06-18 14:50:33 UTC (rev 22080)
+++ gnunet/doc/man/gnunet-publish.1     2012-06-18 15:00:12 UTC (rev 22081)
@@ -6,14 +6,12 @@
 [\fIOPTIONS\fR] FILENAME
 .SH DESCRIPTION
 .PP
-In order to share files with other GNUnet users, the files must first be made 
available to GNUnet.  GNUnet does not automatically share all files from a 
certain directory.  In fact, even files that are downloaded are not 
automatically shared.
+In order to share files with other GNUnet users, the files must first be made 
available to GNUnet.  GNUnet does not automatically share all files from a 
certain directory (however, you can do this with the gnunet\-auto\-share tool). 
 In fact, even files that are downloaded are not automatically shared.
 .PP
 In order to start sharing files, the files must be added either using 
gnunet\-publish or a graphical interface such as gnunet\-fs\-gtk.  The command 
line tool gnunet\-publish is more useful if many files are supposed to be 
added.  gnunet\-publish can automatically publish batches of files, recursively 
publish directories, create directories that can be browsed within GNUnet and 
publish file lists in a namespace.  When run on a directory, gnunet\-publish 
will always recursively publish all of the files in the directory.
 .PP
 gnunet\-publish can automatically extract keywords from the files that are 
shared.  Users that want to download files from GNUnet use keywords to search 
for the appropriate content.  You can disable keyword extraction with the \-D 
option.  You can manually add keywords using the \-k option. The keywords are 
case\-sensitive.
 .PP
-You can use automatic meta\-data extraction (based on libextractor) or the 
command\-line option \-m to specify meta-data.  For the \-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.  Common meta\-data types are "author name", 
"title" , "mimetype", "filename", "language", "subject" and "keywords".  A full 
list can be obtained from the extract tool using the option \-\-list.  The 
meta\-data is used to help users in searching for files on the network.  
-.PP
 In addition to searching for files by keyword, GNUnet allows organizing files 
into directories.  With directories, the user only needs to find the directory 
in order to be able to download any of the files listed in the directory.  
Directories can contain pointers to other directories.
 .PP
 With gnunet\-publish, it is easy to create new directories simultaneously when 
adding the files.  Simply pass the name of a directory instead of a file.
@@ -171,4 +169,4 @@
 .SH "REPORTING BUGS"
 Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to 
<address@hidden>
 .SH "SEE ALSO"
-\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-pseudonym\fP(1), \fBgnunet\-search\fP(1), 
\fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1)
+\fBgnunet\-auto\-share\fP(1), \fBgnunet\-fs\-gtk\fP(1), 
\fBgnunet\-pseudonym\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), 
\fBgnunet.conf\fP(5), \fBextract\fP(1)

Modified: gnunet/src/fs/fs.conf.in
===================================================================
--- gnunet/src/fs/fs.conf.in    2012-06-18 14:50:33 UTC (rev 22080)
+++ gnunet/src/fs/fs.conf.in    2012-06-18 15:00:12 UTC (rev 22081)
@@ -32,7 +32,7 @@
 PREFIX = @MONKEYPREFIX@
 
 
-[fs-auto-share]
+[gnunet-auto-share]
 BINARY = gnunet-auto-share
 CONFIG = $DEFAULTCONFIG
 

Modified: gnunet/src/include/gnunet_scheduler_lib.h
===================================================================
--- gnunet/src/include/gnunet_scheduler_lib.h   2012-06-18 14:50:33 UTC (rev 
22080)
+++ gnunet/src/include/gnunet_scheduler_lib.h   2012-06-18 15:00:12 UTC (rev 
22081)
@@ -212,6 +212,8 @@
                                         struct GNUNET_NETWORK_FDSet * wfds,
                                         struct GNUNET_NETWORK_FDSet * efds,
                                         struct GNUNET_TIME_Relative timeout);
+
+
 /**
  * Initialize and run scheduler.  This function will return when all
  * tasks have completed.  On systems with signals, receiving a SIGTERM