From a84a256df47c21a80524ac9667cc4077f0b7f049 Mon Sep 17 00:00:00 2001 From: Ben Finney Date: Fri, 4 Mar 2016 15:40:08 +1100 Subject: [PATCH] =?UTF-8?q?Add=20incomplete=20man=20pages=20for=20?= =?UTF-8?q?=E2=80=98zerotier-idtool=E2=80=99=20and=20=E2=80=98zerotier-cli?= =?UTF-8?q?=E2=80=99.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/zerotier-cli.1.txt | 109 ++++++++++++++++++++++++++++++++++++ doc/zerotier-idtool.1.txt | 115 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 224 insertions(+) create mode 100644 doc/zerotier-cli.1.txt create mode 100644 doc/zerotier-idtool.1.txt diff --git a/doc/zerotier-cli.1.txt b/doc/zerotier-cli.1.txt new file mode 100644 index 000000000..ae8a4af77 --- /dev/null +++ b/doc/zerotier-cli.1.txt @@ -0,0 +1,109 @@ +============ +zerotier-cli +============ + +-------------------------------------------------- +management interface for ZeroTier One peer process +-------------------------------------------------- + +:Author: |author| +:Date: 2016-03-04 +:Copyright: + Copyright © 2016 ZeroTier Inc. +:Manual section: 1 +:Manual group: ZeroTier + +.. |command| replace:: **zerotier-cli** +.. |license| replace:: + `GNU General Public License, version 3 or later + `__ + + +SYNOPSIS +======== + +| |command| [ **-j** ] [ **-D** `HOMEDIR` ] [ **-p** `PORT` ] [ **-t** `AUTH_TOKEN` ] \ + `command` [ `COMMAND_ARG` ] + + +DESCRIPTION +=========== + +|command| is a tool to manage the running **zerotier-one**\ (8) +process. + +*ZeroTier* is a peer-to-peer virtual network. Its “virtual layer 1” +(VL1) is implemented in the communication between ZeroTier One peers. +This provides the OSI layer 1 functionality on which to build further +network services. + + +COMMANDS +======== + +|command| **info** + + *FIXME*: display status info + +|command| **listpeers** + + *FIXME*: list all peers + +|command| **listnetworks** + + *FIXME*: list all networks + +|command| **join** `NETWORK` + + *FIXME*: join the network `NETWORK` + +|command| **leave** `NETWORK` + + *FIXME*: leave the network `NETWORK` + + +FILES +===== + +The |command| process will discover the running **zerotier-one**\ (8) +process by examining the specified `HOMEDIR` directory (default: +``/var/lib/zerotier-one``). + + +SEE ALSO +======== + +* **zerotier-one**\ (8) + +* ZeroTier One documentation: + + * Product page ``__. + * Configuration guide ``__. + * Technical FAQ ``__. + + +HISTORY +======= + +The |command| program is developed by ZeroTier Inc. + +This manual page was written by |author|. This is free software: you +may copy, modify and/or distribute this work under the terms of the +|license| as published by the Free Software Foundation. No warranty +expressed or implied. + +.. |author| replace:: |authorname| |authoremail| +.. |authorname| replace:: Ben Finney +.. |authoremail| replace:: + + +.. + Local variables: + mode: rst + coding: utf-8 + time-stamp-format: "%:y-%02m-%02d" + time-stamp-start: "^:Date:[ ]+" + time-stamp-end: "$" + time-stamp-line-limit: 20 + End: + vim: filetype=rst fileencoding=utf-8 : diff --git a/doc/zerotier-idtool.1.txt b/doc/zerotier-idtool.1.txt new file mode 100644 index 000000000..2ff0e4c1c --- /dev/null +++ b/doc/zerotier-idtool.1.txt @@ -0,0 +1,115 @@ +=============== +zerotier-idtool +=============== + +---------------------------------------------- +identity management tool for ZeroTier One peer +---------------------------------------------- + +:Author: |author| +:Date: 2016-03-04 +:Copyright: + Copyright © 2016 ZeroTier Inc. +:Manual section: 1 +:Manual group: ZeroTier + +.. |command| replace:: **zerotier-idtool** +.. |license| replace:: + `GNU General Public License, version 3 or later + `__ + + +SYNOPSIS +======== + +| |command| **generate** [ `SECRET` ] [ `PUBLIC` ] +| |command| **validate** `SECRET` +| |command| **getpublic** `SECRET` +| |command| **sign** `SECRET` +| |command| **verify** `IDENTITY` `FILE` `SIGNATURE` +| |command| **mkcom** `SECRET` `ID`\ **,**\ `VALUE`\ **,**\ `MAX_DELTA` [ ... ] `IDENTITY` + + +DESCRIPTION +=========== + +|command| is a tool to manage identities for the **zerotier-one**\ (8) +program. + +*ZeroTier* is a peer-to-peer virtual network. Its “virtual layer 1” +(VL1) is implemented in the communication between ZeroTier One peers. +This provides the OSI layer 1 functionality on which to build further +network services. + + +COMMANDS +======== + +|command| **generate** [ `SECRET` ] [ `PUBLIC` ] + + *FIXME*: generate an identity + +|command| **validate** `SECRET` + + *FIXME*: validate a secret identity + +|command| **getpublic** `SECRET` + + *FIXME*: get a public identity + +|command| **sign** `SECRET` + + *FIXME*: sign a secret identity + +|command| **verify** `IDENTITY` `FILE` `SIGNATURE` + + *FIXME*: verify a signature + +|command| **mkcom** `SECRET` `ID`\ **,**\ `VALUE`\ **,**\ `MAX_DELTA` [ ... ] `IDENTITY` + + *FIXME*: mkcom + + +FILES +===== + +*FIXME*: how does the process know its home directory? + + +SEE ALSO +======== + +* **zerotier-one**\ (8) + +* ZeroTier One documentation: + + * Product page ``__. + * Configuration guide ``__. + * Technical FAQ ``__. + + +HISTORY +======= + +The |command| program is developed by ZeroTier Inc. + +This manual page was written by |author|. This is free software: you +may copy, modify and/or distribute this work under the terms of the +|license| as published by the Free Software Foundation. No warranty +expressed or implied. + +.. |author| replace:: |authorname| |authoremail| +.. |authorname| replace:: Ben Finney +.. |authoremail| replace:: + + +.. + Local variables: + mode: rst + coding: utf-8 + time-stamp-format: "%:y-%02m-%02d" + time-stamp-start: "^:Date:[ ]+" + time-stamp-end: "$" + time-stamp-line-limit: 20 + End: + vim: filetype=rst fileencoding=utf-8 :