doc/man/gnunet-gns.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 March 23, 2018
  25 .Dt GNUNET-GNS 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-gns
  29 .Nd
  30 access to GNU Name System
  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 l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  37 .Op Fl r | \-raw
  38 .Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE
  39 .Op Fl u Ar NAME | Fl \-lookup= Ns Ar NAME
  40 .Op Fl v | \-version
  41 .Sh DESCRIPTION
  42 .Nm
  43 can be used to lookup and process GNU Name Service names.
  44 .Bl -tag -width indent
  45 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  46 Use the configuration file FILENAME.
  47 .It Fl h | \-help
  48 Print short help on options.
  49 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  50 Use LOGLEVEL for logging.
  51 Valid values are DEBUG, INFO, WARNING and ERROR.
  52 .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  53 Write logs to FILENAME.
  54 .It Fl r | \-raw
  55 No unneeded output.
  56 This is a quiet mode where only important information is displayed.
  57 For example a lookup for an IP address will only yield the IP address, no descriptive text.
  58 .It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE
  59 Resource Record Type (TYPE) to look for.
  60 Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, MX, LEHO, VPN, REV, PTR, TXT.
  61 Defaults to "A".
  62 .It Fl u Ar NAME | Fl \-lookup= Ns Ar NAME
  63 Name to lookup.
  64 Resolve the specified name using the GNU Name System.
  65 .It Fl v | \-version
  66 Print GNUnet version number.
  67 .El
  68 .Sh DIAGNOSTICS
  69 .Nm
  70 will return 0 on success, 1 on internal failures, 2 on
  71 launch failures, 4 if the given name is not configured to use GNS.
  72 .Sh SEE ALSO
  73 .Xr gnunet-namestore 1 ,
  74 .Xr gnunet-identity 1
  75 .sp
  76 The full documentation for gnunet is maintained as a Texinfo manual.
  77 If the
  78 .Xr info 1
  79 and gnunet programs are properly installed at your site, the command
  80 .Pp
  81 .Dl info gnunet
  82 .Pp
  83 should give you access to the complete handbook,
  84 .Pp
  85 .Dl info gnunet-c-tutorial
  86 .Pp
  87 will give you access to a tutorial for developers.
  88 .sp
  89 Depending on your installation, this information is also available in
  90 .Xr gnunet 7 and
  91 .Xr gnunet-c-tutorial 7 .
  92 .\".Sh HISTORY
  93 .\".Sh AUTHORS
  94 .Sh BUGS
  95 Report bugs by using
  96 .Lk https://bugs.gnunet.org
  97 or by sending electronic mail to
  98 .Aq Mt gnunet-developers@gnu.org .