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