zerotier-one/doc/zerotier-one.8.txt

============
zerotier-one
============

-------------------------------------------------
end-point peer for ZeroTier virtual network layer
-------------------------------------------------

:Author: |author|
:Date: 2016-03-04
:Copyright:
    Copyright © 2016 ZeroTier Inc.
:Manual section: 8
:Manual group: ZeroTier

..  |command| replace:: **zerotier-one**
..  |license| replace::
    `GNU General Public License, version 3 or later
    <https://www.gnu.org/licenses/#GPL>`__


SYNOPSIS
========

| |command| [ **-U** ] [ **-p** `PORT` ] [ **-d** ] [ `HOMEDIR` ]
| |command| **-i** [ `IDTOOL_ARG` ... ]
| |command| **-q** [ `QUERY_ARG` ... ]
| |command| **-h**
| |command| **-v**


DESCRIPTION
===========

**ZeroTier One** is the end-point peer for the ZeroTier
software-defined network layer.

*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.


OPTIONS
=======

**-h**
    Display concise help on command usage.

**-v**
    Display program version.

**-U**
    Run as unprivileged user (skip privilege check).

**-p** `PORT`
    Communicate on network port `PORT` (either TCP or UDP).

**-d**
    Become a conventional daemon process. Only available on Unix-like
    operating systems.

**-i** [ `IDTOOL_ARG` ... ]
    Generate and manage identities.

    This is equivalent to running the **zerotier-idtool** command with
    all the specified `IDTOOL_ARG` parameters.

**-q** [ `QUERY_ARG` ... ]
    Query the running ZeroTier One process.

    This is equivalent to running the **zerotier-cli** command with
    all the specified `QUERY_ARG` parameters.


FILES
=====

The |command| process will store its state in files within the
specified `HOMEDIR` directory (default: ``/var/lib/zerotier-one``).


SEE ALSO
========

* **zerotier-idtool**\ (1), **zerotier-cli**\ (1)

* ZeroTier One documentation:

  * Product page `<https://www.zerotier.com/product-one.shtml>`__.
  * Configuration guide `<https://www.zerotier.com/config.shtml>`__.
  * Technical FAQ `<https://www.zerotier.com/tech_faq.shtml>`__.


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:: <ben+zerotier@benfinney.id.au>


..
    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 :