doc/man/gnunet-fs.1

   1 .\" This file is part of GNUnet.
   2 .\" Copyright (C) 2001-2019 GNUnet e.V.
   3 .\"
   4 .\" Permission is granted to copy, distribute and/or modify this document
   5 .\" under the terms of the GNU Free Documentation License, Version 1.3 or
   6 .\" any later version published by the Free Software Foundation; with no
   7 .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
   8 .\" copy of the license is included in the file
   9 .\" FDL-1.3.
  10 .\"
  11 .\" A copy of the license is also available from the Free Software
  12 .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
  13 .\"
  14 .\" Alternately, this document is also available under the General
  15 .\" Public License, version 3 or later, as published by the Free Software
  16 .\" Foundation.  A copy of the license is included in the file
  17 .\" GPL3.
  18 .\"
  19 .\" A copy of the license is also available from the Free Software
  20 .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
  21 .\"
  22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
  23 .\"
  24 .Dd November 2, 2011
  25 .Dt GNUNET-FS 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-fs
  29 .Nd measure and control the FS subsystem
  30 .Sh SYNOPSIS
  31 .Nm
  32 .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  33 .Op Fl h | -help
  34 .Op Fl i | -list-indexed
  35 .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  36 .Op Fl v | -version
  37 .Op Fl V | -verbose
  38 .Sh DESCRIPTION
  39 .Nm
  40 is a tool to access various functions of GNUnet's FS subsystem
  41 from the command-line.
  42 Most of these are not expected to be useful for end-users.
  43 gnunet-fs can currently only be used to obtain a list of indexed files.
  44 Other functions should be added in the near future.
  45 .Bl -tag -width indent
  46 .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  47 Configuration file to use.
  48 .It Fl h | -help
  49 Print the help page.
  50 .It Fl i | -list-indexed
  51 Print information about files that are currently indexed by file-sharing.
  52 .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  53 Change the loglevel.
  54 Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
  55 .It Fl v | -version
  56 Print the version number.
  57 .It Fl V | -verbose
  58 Be verbose.
  59 .El
  60 .Sh SEE ALSO
  61 .Xr gnunet-publish 1
  62 .Pp
  63 The full documentation for gnunet is maintained as a Texinfo manual.
  64 If the
  65 .Xr info 1
  66 and gnunet programs are properly installed at your site, the command
  67 .Pp
  68 .Dl info gnunet
  69 .Pp
  70 should give you access to the complete handbook,
  71 .Pp
  72 .Dl info gnunet-c-tutorial
  73 .Pp
  74 will give you access to a tutorial for developers.
  75 .Pp
  76 Depending on your installation, this information is also available in
  77 .Xr gnunet 7 and
  78 .Xr gnunet-c-tutorial 7 .
  79 .\".Sh HISTORY
  80 .\".Sh AUTHORS
  81 .Sh BUGS
  82 Report bugs by using
  83 .Lk https://bugs.gnunet.org
  84 or by sending electronic mail to
  85 .Aq Mt gnunet-developers@gnu.org .