man: license headers
[oweals/gnunet.git] / doc / man / gnunet-namecache.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 October 16, 2013
25 .Dt GNUNET-NAMECACHE 1
26 .Os
27 .Sh NAME
28 .Nm gnunet-namecache
29 .Nd
30 inspect namecache
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 n Ar NAME | Fl \-name= Ns Ar NAME
37 .Op Fl v | \-version
38 .Op Fl z Ar PKEY | Fl \-zone= Ns Ar PKEY
39 .Sh DESCRIPTION
40 .Nm
41 can be used to inspect values in the namecache.
42 It is passed the mandatory option 'z' ('--zone=') with the argument PKEY, and the mandatory option 'n' ('--name=') with the argument NAME.
43 .Bl -tag -width Ds
44 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
45 Use the configuration file FILENAME.
46 .It Fl h | \-help
47 Print short help on options.
48 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
49 Use LOGLEVEL for logging.
50 Valid values are DEBUG, INFO, WARNING and ERROR.
51 .It Fl n Ar NAME | Fl \-name= Ns Ar NAME
52 Name (label) of the record to display (mandatory option).
53 .It Fl v | \-version
54 Print GNUnet version number.
55 .It Fl z Ar PKEY | Fl \-zone= Ns Ar PKEY
56 Specifies the public key of the zone to inspect (mandatory option)
57 .El
58 .\".Sh EXAMPLES
59 .Sh SEE ALSO
60 .Xr gnunet-gns 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 .