doc/man/gnunet-directory.1

   1 .TH GNUNET-DIRECTORY "1" "February 25, 2012" "GNUnet"
   2 .SH NAME
   3 gnunet\-directory \- display directories
   4 .SH SYNOPSIS
   5 .B gnunet\-directory
   6 [\fIOPTIONS\fR] (FILENAME)*
   7 .SH DESCRIPTION
   8 .PP
   9 gnunet\-directory lists the contents of one or more GNUnet directories.
  10 A GNUnet directory is a binary file that contains a list of GNUnet
  11 file\-sharing URIs and meta data.  The names of the directory files must
  12 be passed as command\-line arguments to gnunet\-directory.
  13 .TP
  14 \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
  15 configuration file to use (useless option since gnunet\-directory does not
  16 really depend on any configuration options)
  17 .TP
  18 \fB\-h\fR, \fB\-\-help\fR
  19 print help page
  20 .TP
  21 \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
  22 Change the loglevel.  Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
  23 .TP
  24 \fB\-v\fR, \fB\-\-version\fR
  25 print the version number
  26 .SH NOTES
  27 A GNUnet directory is a file containing a list of GNUnet URIs and meta data.
  28 The keys can point to files, other directories or files in namespaces.  In other
  29 words, a GNUnet directory is similar to UNIX directories.  The difference to tar
  30 and zip is that GNUnet directory does not contain the actual files (except if
  31 they are really small, in which case they may be inlined), just symbolic (links),
  32 similar to directories with symbolic links in UNIX filesystems.  The benefit is
  33 that the individual files can be retrieved separately (if desired) and if some
  34 of the files are inserted to another node in GNUnet, this just increases their
  35 availability but does not produce useless duplicates (for example, it is a
  36 better idea to publish a collection of pictures or compressed sound files
  37 using a GNUnet directory instead of processing them with archivers such as
  38 tar or zip first).  Directories can contain arbitrary meta data for each file.
  39 .PP
  40 If a directory has missing blocks (for example, some blocks failed to download),
  41 GNUnet is typically able to retrieve information about other files in the
  42 directory.  Files in a GNUnet directory have no particular order; the GNUnet
  43 code that generates a directory can reorder the entries in order to better
  44 fit the information about files into blocks of 32k.  Respecting 32k boundaries
  45 where possible makes it easier for gnunet\-directory (and other tools) to
  46 recover information from partially downloaded directory files.
  47 .PP
  48 At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP
  49 and \fBgnunet\-publish\fP.  Just like ordinary files, a directory can be
  50 published in a namespace.
  51 .PP
  52 GNUnet directories use the (unregistered)
  53 mimetype \fBapplication/gnunet\-directory\fP.  They can show up among normal
  54 search results.  The directory file can be downloaded to disk
  55 by \fBgnunet\-download\fP(1) for later processing or be handled more directly
  56 by \fBgnunet\-fs\-gtk\fP(1).
  57
  58 .SH BUGS
  59 Report bugs by using mantis <https://bugs.gnunet.org/> or by sending
  60 electronic mail to <gnunet\-developers@gnu.org>
  61 .SH SEE ALSO
  62 \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
  63 \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1)
  64 The full documentation for
  65 .B gnunet
  66 is maintained as a Texinfo manual.
  67 If the
  68 .B info
  69 and
  70 .B gnunet
  71 programs are properly installed at your site, the command
  72 .IP
  73 .B info gnunet
  74 .PP
  75 should give you access to the complete handbook,
  76 .IP
  77 .B info gnunet-c-tutorial
  78 .PP
  79 will give you access to a tutorial for developers.
  80 .PP
  81 Depending on your installation, this information is also
  82 available in
  83 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).