[GNUnet-SVN] [ascension] 53/57: Add ascension.1

[gnunet]

This is an automated email from the git hooks/post-receive script.

ng0 pushed a commit to branch master
in repository ascension.

commit 78767fcf13fdb90a12a4176ba4b114349f9b3cc0
Author: ng0 <address@hidden>
AuthorDate: Thu Mar 7 16:02:52 2019 +0000

    Add ascension.1
---
 .gitignore  |   4 +++
 ascension.1 | 107 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 setup.py    |   1 +
 3 files changed, 112 insertions(+)

diff --git a/.gitignore b/.gitignore
index 4c5f90e..15c12ec 100644
--- a/.gitignore
+++ b/.gitignore
@@ -97,3 +97,7 @@ ENV/
 /site
 .idea/
 managed-keys.bind.jnl
+
+# editors
+*~
+\#*\#
diff --git a/ascension.1 b/ascension.1
new file mode 100644
index 0000000..4f688ef
--- /dev/null
+++ b/ascension.1
@@ -0,0 +1,107 @@
+.\" This file is part of Ascension.
+.\" Copyright (C) 2019 GNUnet e.V.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\" 
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
+.Dd March 7, 2019
+.Dt ASCENSION 1
+.Os
+.Sh NAME
+.Nm ascension
+.Nd migrate existing DNS zones into the GNU Name System
+.Sh SYNOPSIS
+.Nm
+.Op Ar domain Fl d Fl p
+.Op Ar domain port Fl d Fl p
+.Op Ar domain Fl n Ar transferns Fl d Fl p
+.Op Ar domain Fl n Ar transferns Ar port Fl d Fl p
+.Op Fl d | \-debug
+.Op Fl h | \-help
+.Op Fl p | \-public
+.Op Fl v | \-version
+.Sh DESCRIPTION
+.Nm
+is a tool to migrate existing DNS Zones into the GNU Name System (GNS) using 
incremental zone transfers (AXFR/IXFR).
+To achieve this it uses
+.Xr gnunet-identity 1 ,
+.Xr gnunet-namestore 1 ,
+.Xr gnunet-gns 1 .
+As
+.Nm
+relies on these 3 GNUnet services,
+.Xr gnunet-arm 1
+must be installed and running.
+.Bl -tag -width Ds
+.It Ar domain Fl d Fl p
+Migrate the DOMAIN passed as domain.
+The debug and public options are optional.
+.It Ar domain port Fl d Fl p
+Migrate the DOMAIN domain, using port for zone transfer.
+The debug and public options are optional.
+.It Ar domain Fl n Ar transferns Fl d Fl p
+Migrate the DOMAIN domain from the DNS server transferns.
+The debug and public options are optional.
+.It Ar domain Fl n Ar transferns Ar port Fl d Fl p
+Migrate the DOMAIN domain from the DNS server transferns using port for the 
zone transfer.
+The debug and public options are optional.
+.It Fl d | \-debug
+Enable debugging
+.It Fl h | \-help
+Print short help on options
+.It Fl p | \-public
+Make records public on the DHT
+.It Fl v | \-version
+Print ascension version number
+.El
+.\" .Sh FILES
+.Sh EXAMPLES
+To transfer the sy TLD from ns1.tld.sy:
+.Pp
+.Dl $ ascension sy -n ns1.tld.sy.
+.Pp
+To transfer the nu TLD from zonedata.iis.se with debug options enabled:
+.Pp
+.Dl $ ascension nu -n zonedata.iis.se. -d
+.Sh SEE ALSO
+.Xr gnunet-identity 1 ,
+.Xr gnunet-namestore 1 ,
+.Xr gnunet-gns 1 ,
+.Xr gnunet-arm 1 .
+.Sh HISTORY
+The
+.Nm
+tool was designed and written in 2018 by
+.An rexxnor Aq Mt address@hidden .
+.Sh AUTHORS
+This man page was written by
+.An ng0 Aq Mt address@hidden ,
+it first appeared in
+.Nm
+0.5.1.
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt address@hidden .
diff --git a/setup.py b/setup.py
index f4731cf..d60cb86 100644
--- a/setup.py
+++ b/setup.py
@@ -35,6 +35,7 @@ setuptools.setup(
     long_description=long_description,
     url="https://gnunet.org/git/ascension.git/";,
     packages=['ascension'],
+    data_files=[('man/man1', ['ascension.1'])],
     classifiers=[
         "Programming Language :: Python :: 3",
     ],

-- 
To stop receiving notification emails like this one, please contact
address@hidden