syntax
[oweals/gnunet.git] / doc / man / gnunet-core.1
1 .Dd April 11, 2014
2 .Dt GNUNET-CORE 1
3 .Os
4 .Sh NAME
5 .Nm gnunet-core
6 .Nd
7 monitor CORE subsystem
8 .Sh SYNOPSIS
9 .Nm
10 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
11 .Op Fl h | \-help
12 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
13 .Op Fl m | \-monitor
14 .Op Fl v | \-version
15 .Op Fl V | \-verbose
16 .Sh DESCRIPTION
17 .Nm
18 is a tool to access various functions of GNUnet's core subsystem from the command-line.
19 The only function right now is to monitor the status of peers known to the CORE service.
20 .Bl -tag -width Ds
21 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
22 Configuration file to use.
23 .It Fl h | \-help
24 Print the help page.
25 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
26 Change the loglevel.
27 Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
28 .It Fl m | \-monitor
29 in monitor mode, gnunet-core will continuously print the connection status, instead of giving just a snapshot.
30 .It Fl v | \-version
31 Print the version number.
32 .It Fl V | \-verbose
33 Be verbose.
34 .El
35 .\".Sh EXAMPLES
36 .Sh SEE ALSO
37 .Xr gnunet-transport 1
38 .sp
39 The full documentation for gnunet is maintained as a Texinfo manual.
40 If the
41 .Xr info 1
42 and gnunet programs are properly installed at your site, the command
43 .Pp
44 .Dl info gnunet
45 .Pp
46 should give you access to the complete handbook,
47 .Pp
48 .Dl info gnunet-c-tutorial
49 .Pp
50 will give you access to a tutorial for developers.
51 .sp
52 Depending on your installation, this information is also available in
53 .Xr gnunet 7 and
54 .Xr gnunet-c-tutorial 7 .
55 .\".Sh HISTORY
56 .\".Sh AUTHORS
57 .Sh BUGS
58 Report bugs by using
59 .Lk https://bugs.gnunet.org
60 or by sending electronic mail to
61 .Aq Mt gnunet-developers@gnu.org .