[GNUnet-SVN] r6343 - GNUnet/doc/man

[gnunet]

Author: grothoff
Date: 2008-02-16 21:46:58 -0700 (Sat, 16 Feb 2008)
New Revision: 6343

Modified:
   GNUnet/doc/man/gnunet-auto-share.1
   GNUnet/doc/man/gnunet-insert.1
Log:
update to man page

Modified: GNUnet/doc/man/gnunet-auto-share.1
===================================================================
--- GNUnet/doc/man/gnunet-auto-share.1  2008-02-17 04:34:50 UTC (rev 6342)
+++ GNUnet/doc/man/gnunet-auto-share.1  2008-02-17 04:46:58 UTC (rev 6343)
@@ -31,7 +31,42 @@
 be read (using the same absolute path) by gnunetd, so you should
 run gnunet\-auto\-share on the same machine that uses gnunetd.
 .PP
+You can add metadata for the shared files by specifying metadata in
+a metadata configuration file (by default located in 
+~/.gnunet/metadata.conf).  The format of this file is just like
+the normal GNUnet configuration files.  Each section name should
+correspond to a filename in the directory.  The keys are the 
+various metadata types and the entries correspond to the metadata
+values.  The special type "keyword" can be used to specify a list
+of keywords that should be used for the respective file.  Multiple
+keywords should be separated by "AND".  Example:
 
+ [COPYING]
+ title = "The GNU Public License"
+ copyright = "1989, 1991 Free Software Foundation, Inc."
+ version = "2"
+ date = "June 1991"
+ mimetype = "text/plain"
+ description = "The most frequently used free software license"
+ language = "English"
+ organization = "Free Software Foundation"
+ keywords = "GPL AND GNU AND free AND license AND public AND FSF AND test"
+ 
+ [gnunet-logo.svg]
+ title = "Official logo of teh GNUnet project"
+ description = "Combines the GNU logo with a spider-net"
+ mimetype = "image/svg+xml"
+ artist = "Nicklas Larsson"
+ date = "14.7.2005"
+ organization = "The GNU Project"
+ keywords = "GNUnet AND logo"
+ contributor = "Christian Muellner"
+
+Metadata specification only works for files in the top-level
+directory, all other files will only be listed as part of the
+top-level directories and be given metadata using 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).

Modified: GNUnet/doc/man/gnunet-insert.1
===================================================================
--- GNUnet/doc/man/gnunet-insert.1      2008-02-17 04:34:50 UTC (rev 6342)
+++ GNUnet/doc/man/gnunet-insert.1      2008-02-17 04:46:58 UTC (rev 6343)
@@ -265,19 +265,19 @@
 
 Index a file COPYING:
 
-# gnunet\-insert COPYING
+ # gnunet\-insert COPYING
 
 Insert a file COPYING:
 
-# gnunet\-insert \-n COPYING
+ # gnunet\-insert \-n COPYING
 
 Index a file COPYING with the keywords \fBgpl\fR and \fBtest\fR:
 
-# gnunet\-insert \-k gpl \-k test COPYING
+ # gnunet\-insert \-k gpl \-k test COPYING
 
 Index a file COPYING with description "GNU License", mime-type "text/plain" 
and keywords \fBgpl\fR and \fBtest\fR:
 
-# gnunet\-insert \-m "description:GNU License" \-k gpl \-k test -m 
"mimetype:text/plain" COPYING
+ # gnunet\-insert \-m "description:GNU License" \-k gpl \-k test -m 
"mimetype:text/plain" COPYING
 
 \fBUsing directories\fR
 
@@ -286,21 +286,21 @@
 available under keyword \fBgnu\fR and disable keyword extraction using
 libextractor:
 
-# mkdir gnu
-# mv COPYING AUTHORS gnu/
-# gnunet\-insert \-K test \-k gnu \-D gnu/
+ # mkdir gnu
+ # mv COPYING AUTHORS gnu/
+ # gnunet\-insert \-K test \-k gnu \-D gnu/
 
 Neatly publish an image gallery in \fBkittendir/\fR and its subdirs
 with keyword \fBkittens\fR for the directory but no keywords for the
 individual files or subdirs (\-n).  Force description for all files:
 
-# gnunet\-insert \-n \-m "description:Kitten collection" \-k kittens kittendir/
+ # gnunet\-insert \-n \-m "description:Kitten collection" \-k kittens 
kittendir/
 
 \fBSecure publishing with namespaces\fR
 
 Insert file COPYING with pseudonym RIAA (\-P) and with identifier \fBgpl\fR 
(\-t) and no updates:
 
-# gnunet\-insert \-P RIAA \-t gpl COPYING
+ # gnunet\-insert \-P RIAA \-t gpl COPYING
 
 Recursively index /home/ogg and build a matching directory
 structure.  Insert the top\-level directory into the namespace under
@@ -308,7 +308,7 @@
 provide an update with identifier VIDEOS (\-N) at an arbitrary point
 in the future (\-S is implied by lack of \-i and presence of \-N):
 
-# gnunet\-insert \-P RIAA \-t MUSIC \-N VIDEOS /home/ogg
+ # gnunet\-insert \-P RIAA \-t MUSIC \-N VIDEOS /home/ogg
 
 Recursively insert (\-n) /var/lib/mysql and build a matching
 directory structure, but disable the use of libextractor to extract
@@ -318,16 +318,16 @@
 people that have been told the secret file identifiers printed with
 the \-V option can retrieve the (secret?) files:
 
-# gnunet\-insert \-nV /var/lib/mysql
+ # gnunet\-insert \-nV /var/lib/mysql
 
 Create a periodical SBlock with a sporadic update interval and announce
 that the next update will be called 'next':
 
-# gnunet\-insert \-P MPAA \-N next \-S noise.mp3
+ # gnunet\-insert \-P MPAA \-N next \-S noise.mp3
 
 Update the periodical SBlock using settings from a previous time:
 
-# gnunet\-insert \-P MPAA \-t next -N nextnext noise_updated.mp3
+ # gnunet\-insert \-P MPAA \-t next -N nextnext noise_updated.mp3
 
 
 .SH FILES