zerotier-cli.1.txt 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. ============
  2. zerotier-cli
  3. ============
  4. --------------------------------------------------
  5. management interface for ZeroTier One peer process
  6. --------------------------------------------------
  7. :Author: |author|
  8. :Date: 2016-03-04
  9. :Copyright:
  10. Copyright © 2016 ZeroTier Inc.
  11. :Manual section: 1
  12. :Manual group: ZeroTier
  13. .. |command| replace:: **zerotier-cli**
  14. .. |license| replace::
  15. `GNU General Public License, version 3 or later
  16. <https://www.gnu.org/licenses/#GPL>`__
  17. SYNOPSIS
  18. ========
  19. | |command| [ **-j** ] [ **-D** `HOMEDIR` ] [ **-p** `PORT` ] [ **-t** `AUTH_TOKEN` ] \
  20. `command` [ `COMMAND_ARG` ]
  21. DESCRIPTION
  22. ===========
  23. |command| is a tool to manage the running **zerotier-one**\ (8)
  24. process.
  25. *ZeroTier* is a peer-to-peer virtual network. Its “virtual layer 1”
  26. (VL1) is implemented in the communication between ZeroTier One peers.
  27. This provides the OSI layer 1 functionality on which to build further
  28. network services.
  29. COMMANDS
  30. ========
  31. |command| **info**
  32. *FIXME*: display status info
  33. |command| **listpeers**
  34. *FIXME*: list all peers
  35. |command| **listnetworks**
  36. *FIXME*: list all networks
  37. |command| **join** `NETWORK`
  38. *FIXME*: join the network `NETWORK`
  39. |command| **leave** `NETWORK`
  40. *FIXME*: leave the network `NETWORK`
  41. FILES
  42. =====
  43. The |command| process will discover the running **zerotier-one**\ (8)
  44. process by examining the specified `HOMEDIR` directory (default:
  45. ``/var/lib/zerotier-one``).
  46. SEE ALSO
  47. ========
  48. * **zerotier-one**\ (8)
  49. * ZeroTier One documentation:
  50. * Product page `<https://www.zerotier.com/product-one.shtml>`__.
  51. * Configuration guide `<https://www.zerotier.com/config.shtml>`__.
  52. * Technical FAQ `<https://www.zerotier.com/tech_faq.shtml>`__.
  53. HISTORY
  54. =======
  55. The |command| program is developed by ZeroTier Inc.
  56. This manual page was written by |author|. This is free software: you
  57. may copy, modify and/or distribute this work under the terms of the
  58. |license| as published by the Free Software Foundation. No warranty
  59. expressed or implied.
  60. .. |author| replace:: |authorname| |authoremail|
  61. .. |authorname| replace:: Ben Finney
  62. .. |authoremail| replace:: <ben+zerotier@benfinney.id.au>
  63. ..
  64. Local variables:
  65. mode: rst
  66. coding: utf-8
  67. time-stamp-format: "%:y-%02m-%02d"
  68. time-stamp-start: "^:Date:[ ]+"
  69. time-stamp-end: "$"
  70. time-stamp-line-limit: 20
  71. End:
  72. vim: filetype=rst fileencoding=utf-8 :