style fix
[oweals/gnunet.git] / doc / man / gnunet-conversation.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 October 5, 2013
25 .Dt GNUNET-CONVERSATION 1
26 .Os
27 .Sh NAME
28 .Nm gnunet-conversation
29 .Nd
30 have a conversation with your peers
31 .Sh SYNOPSIS
32 .Nm
33 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34 .Op Fl e Ar NAME | Fl \-ego= Ns Ar NAME
35 .Op Fl h | \-help
36 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
37 .Op Fl p Ar LINE | Fl \-phone= Ns Ar LINE
38 .Op Fl v | \-version
39 .Ao Ar URI Ac
40 .Sh DESCRIPTION
41 .Nm
42 can be used to have a conversation with other GNUnet users.
43 You can make calls and receive incoming calls.
44 You need to setup an ego using gnunet\-identity first.
45 For others to be able to call you, you must add a PHONE record to your zone in the GNU Name System (using gnunet\-namestore).
46 gnunet\-conversation has an interactive help system via the /help command.
47 .Bl -tag -width indent
48 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
49 Use the configuration file FILENAME.
50 .It Fl e Ar NAME | Fl \-ego= Ns Ar NAME
51 Specifies the NAME of the ego to use (for caller ID).
52 .It Fl h | \-help
53 Print short help on options.
54 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
55 Use LOGLEVEL for logging.
56 Valid values are DEBUG, INFO, WARNING and ERROR.
57 .It Fl p Ar LINE | Fl \-phone= Ns Ar LINE
58 Optional argument that can be used to specify the phone LINE to be used with the conversation service.
59 The default LINE is zero, which should be fine for most users.
60 .It Fl v | \-version
61 Print GNUnet version number.
62 .El
63 .\".Sh EXAMPLES
64 .Sh SEE ALSO
65 .Xr gnunet-gns 1 ,
66 .Xr gnunet-identity 1 ,
67 .Xr gnunet-namestore 1
68 .sp
69 The full documentation for gnunet is maintained as a Texinfo manual.
70 If the
71 .Xr info 1
72 and gnunet programs are properly installed at your site, the command
73 .Pp
74 .Dl info gnunet
75 .Pp
76 should give you access to the complete handbook,
77 .Pp
78 .Dl info gnunet-c-tutorial
79 .Pp
80 will give you access to a tutorial for developers.
81 .sp
82 Depending on your installation, this information is also available in
83 .Xr gnunet 7 and
84 .Xr gnunet-c-tutorial 7 .
85 .\".Sh HISTORY
86 .\".Sh AUTHORS
87 .Sh BUGS
88 Report bugs by using
89 .Lk https://bugs.gnunet.org
90 or by sending electronic mail to
91 .Aq Mt gnunet-developers@gnu.org .