summaryrefslogtreecommitdiff
path: root/doc/man/gnunet-fs.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-fs.1')
-rw-r--r--doc/man/gnunet-fs.1131
1 files changed, 79 insertions, 52 deletions
diff --git a/doc/man/gnunet-fs.1 b/doc/man/gnunet-fs.1
index dcaf90d72..ea0bb8cb0 100644
--- a/doc/man/gnunet-fs.1
+++ b/doc/man/gnunet-fs.1
@@ -1,58 +1,85 @@
-.TH GNUNET\-FS "1" "November 2, 2011" "GNUnet"
-.SH NAME
-gnunet\-fs \- measure and control the fs subsystem
-.SH SYNOPSIS
-.B gnunet\-fs
-[\fIOPTIONS\fR]
-.SH DESCRIPTION
-.PP
-gnunet\-fs is a tool to access various functions of GNUnet's fs
-subsystem from the command\-line.
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2001-2019 GNUnet e.V.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
+.\" copy of the license is included in the file
+.\" ``FDL-1.3''.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
+.\"
+.\" Alternately, this document is also available under the General
+.\" Public License, version 3 or later, as published by the Free Software
+.\" Foundation. A copy of the license is included in the file
+.\" ``GPL3''.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
+.\"
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
+.\"
+.Dd November 2, 2011
+.Dt GNUNET-FS 1
+.Os
+.Sh NAME
+.Nm gnunet-fs
+.Nd
+measure and control the fs subsystem
+.Sh SYNOPSIS
+.Nm
+.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+.Op Fl h | \-help
+.Op Fl i | \-list-indexed
+.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+.Op Fl v | \-version
+.Op Fl V | \-verbose
+.Sh DESCRIPTION
+.Nm
+is a tool to access various functions of GNUnet's FS subsystem from the command\-line.
Most of these are not expected to be useful for end-users.
-gnunet\-fs can currently only be used to obtain a list of indexed
-files.
+gnunet\-fs can currently only be used to obtain a list of indexed files.
Other functions should be added in the near future.
-.TP
-\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
-configuration file to use
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-print help page
-.TP
-\fB\-i\fR, \fB\-\-list-indexed\fR
-print information about files that are currently indexed by
-file-sharing
-.TP
-\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
+.Bl -tag -width Ds
+.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+Configuration file to use.
+.It Fl h | \-help
+Print help page.
+.It Fl i | \-list-indexed
+Print information about files that are currently indexed by file-sharing.
+.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
Change the loglevel.
Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
-.TP
-\fB\-v\fR, \fB\-\-version\fR
-print the version number
-.TP
-\fB\-V\fR, \fB\-\-verbose\fR
-be verbose
-.SH BUGS
-Report bugs by using mantis <https://bugs.gnunet.org/> or by sending
-electronic mail to <gnunet\-developers@gnu.org>
-.SH SEE ALSO
-\fBgnunet\-publish\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
+.It Fl v | \-version
+Print the version number.
+.It Fl V | \-verbose
+Be verbose.
+.El
+.Sh SEE ALSO
+.Xr gnunet-publish 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 .