ascension

Migrate DNS zones to the GNU Name System
Log | Files | Refs | README | LICENSE

ascension.1 (3530B)


      1 .\" This file is part of Ascension.
      2 .\" Copyright (C) 2018,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 May 1, 2019
     25 .Dt ASCENSION 1
     26 .Os
     27 .Sh NAME
     28 .Nm ascension
     29 .Nd migrate existing DNS zones into the GNU Name System
     30 .Sh SYNOPSIS
     31 .Nm
     32 .Op Ar domain Fl d Fl p Fl s \- minimum-ttl=<ttl> \- dry-run
     33 .Op Ar domain port Fl d Fl p Fl s \- minimum-ttl=<ttl> \- dry-run
     34 .Op Ar domain Fl n Ar transferns Fl d Fl p Fl s Fl \- minimum-ttl=<ttl> \- dry-run
     35 .Op Ar domain Fl n Ar transferns Ar port Fl d Fl p Fl s \- minimum-ttl=<ttl> \- dry-run
     36 .Op Fl d | \-debug
     37 .Op Fl h | \-help
     38 .Op Fl p | \-public
     39 .Op Fl v | \-version
     40 .Op Fl s | \-standalone
     41 .Sh DESCRIPTION
     42 .Nm
     43 is a tool to migrate existing DNS Zones into the GNU Name System (GNS) using incremental zone transfers (AXFR/IXFR).
     44 To achieve this it uses
     45 .Xr gnunet-identity 1 ,
     46 .Xr gnunet-namestore 1 ,
     47 .Xr gnunet-gns 1 .
     48 As
     49 .Nm
     50 relies on these 3 GNUnet services,
     51 .Xr gnunet-arm 1
     52 must be installed and running.
     53 .Bl -tag -width Ds
     54 .It Ar domain Fl d Fl p Fl s Fl minimum-ttl=<ttl>
     55 Migrate the DOMAIN passed as domain.
     56 The debug, public and standalone options are optional.
     57 .It Ar domain port Fl d Fl p Fl s Fl minimum-ttl=<ttl>
     58 Migrate the DOMAIN domain, using port for zone transfer.
     59 The debug, public and standalone options are optional.
     60 .It Ar domain Fl n Ar transferns Fl d Fl p Fl s Fl minimum-ttl=<ttl>
     61 Migrate the DOMAIN domain from the DNS server transferns.
     62 The debug, public and standalone options are optional.
     63 .It Ar domain Fl n Ar transferns Ar port Fl d Fl p Fl s Fl minimum-ttl=<ttl>
     64 Migrate the DOMAIN domain from the DNS server transferns using port for the zone transfer.
     65 The debug, public and standalone options are optional.
     66 .It Fl s | \-standalone
     67 Run Ascension once
     68 .It Fl d | \-debug
     69 Enable debugging
     70 .It Fl h | \-help
     71 Print short help on options
     72 .It Fl p | \-public
     73 Make records public on the DHT
     74 .It Fl v | \-version
     75 Print ascension version number
     76 .El
     77 .\" .Sh FILES
     78 .Sh EXAMPLES
     79 To transfer the sy TLD from ns1.tld.sy:
     80 .Pp
     81 .Dl $ ascension sy -n ns1.tld.sy.
     82 .Pp
     83 To transfer the nu TLD from zonedata.iis.se with debug options enabled:
     84 .Pp
     85 .Dl $ ascension nu -n zonedata.iis.se. -d
     86 .Sh SEE ALSO
     87 .Xr gnunet-arm 1 ,
     88 .Xr gnunet-gns 1 ,
     89 .Xr gnunet-identity 1 ,
     90 .Xr gnunet-namestore 1
     91 .Sh HISTORY
     92 The
     93 .Nm
     94 tool was designed and written in 2018 by
     95 .An rexxnor Aq Mt rexxnor+gnunet@brief.li .
     96 .Sh AUTHORS
     97 This man page was written by
     98 .An ng0 Aq Mt ng0@gnunet.org
     99 and updated by
    100 .An rexxnor Aq Mt rexxnor+gnunet@brief.li
    101 it first appeared in
    102 .Nm
    103 0.5.1.
    104 .Sh BUGS
    105 Report bugs by using
    106 .Lk https://bugs.gnunet.org
    107 or by sending electronic mail to
    108 .Aq Mt bug-gnunet@gnu.org .