man: license headers
[oweals/gnunet.git] / doc / man / gnunet-core.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 @url{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 @url{http://www.gnu.org/licenses/gpl.html}.
21 .\"
22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23 .\"
24 .Dd April 11, 2014
25 .Dt GNUNET-CORE 1
26 .Os
27 .Sh NAME
28 .Nm gnunet-core
29 .Nd
30 monitor CORE subsystem
31 .Sh SYNOPSIS
32 .Nm
33 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34 .Op Fl h | \-help
35 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
36 .Op Fl m | \-monitor
37 .Op Fl v | \-version
38 .Op Fl V | \-verbose
39 .Sh DESCRIPTION
40 .Nm
41 is a tool to access various functions of GNUnet's core subsystem from the command-line.
42 The only function right now is to monitor the status of peers known to the CORE service.
43 .Bl -tag -width Ds
44 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
45 Configuration file to use.
46 .It Fl h | \-help
47 Print the help page.
48 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
49 Change the loglevel.
50 Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
51 .It Fl m | \-monitor
52 in monitor mode, gnunet-core will continuously print the connection status, instead of giving just a snapshot.
53 .It Fl v | \-version
54 Print the version number.
55 .It Fl V | \-verbose
56 Be verbose.
57 .El
58 .\".Sh EXAMPLES
59 .Sh SEE ALSO
60 .Xr gnunet-transport 1
61 .sp
62 The full documentation for gnunet is maintained as a Texinfo manual.
63 If the
64 .Xr info 1
65 and gnunet programs are properly installed at your site, the command
66 .Pp
67 .Dl info gnunet
68 .Pp
69 should give you access to the complete handbook,
70 .Pp
71 .Dl info gnunet-c-tutorial
72 .Pp
73 will give you access to a tutorial for developers.
74 .sp
75 Depending on your installation, this information is also available in
76 .Xr gnunet 7 and
77 .Xr gnunet-c-tutorial 7 .
78 .\".Sh HISTORY
79 .\".Sh AUTHORS
80 .Sh BUGS
81 Report bugs by using
82 .Lk https://bugs.gnunet.org
83 or by sending electronic mail to
84 .Aq Mt gnunet-developers@gnu.org .