Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
opendht
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Deploy
Model registry
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
savoirfairelinux
opendht
Commits
ab7b8f60
Commit
ab7b8f60
authored
Jun 8, 2019
by
Adrien Béraud
Browse files
Options
Downloads
Patches
Plain Diff
dhtnode: improve manpage
parent
6e523104
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/dhtnode.1
+42
-51
42 additions, 51 deletions
doc/dhtnode.1
with
42 additions
and
51 deletions
doc/dhtnode.1
+
42
−
51
View file @
ab7b8f60
.TH DHTNODE 1 2016-07-29
.TH DHTNODE 1 2019-06-08
.SH NAME
.SH NAME
.B dhtnode
.B dhtnode
- a simple OpenDHT command line node runner.
- a simple OpenDHT command line node runner.
.SH SYNOPSIS
.SH SYNOPSIS
.B dhtnode [-h]
.B dhtnode [\fB\-h\fP]
.B dhtnode [-v [-l \fIlogfile\fP]] [-i [--save-identity \fIfile\fP]] [-d] [-n \fInetwork_id\fP] [-p \fIlocal_port\fP] [-b \fIbootstrap_host\fP[:\fIport\fP]] [--certificate \fIfile\fP] [--privkey \fIfile\fP] [--privkey-password \fIpassword\fP]
.B dhtnode
[\fB-v\fP [\fB\-l\fP \fIlogfile\fP] [\fB\-L\fP]]
[\fB\-i\fP [\fB\-\-save\-identity\fP \fIfile\fP]]
[\fB\-d\fP] [\fB\-s\fP]
[\fB\-n\fP \fInetwork_id\fP]
[\fB\-p\fP \fIlocal_port\fP]
[\fB\-b\fP \fIbootstrap_host\fP[:\fIport\fP]]
[\fB\-\-certificate\fP \fIfile\fP]
[\fB\-\-privkey\fP \fIfile\fP]
[\fB\-\-privkey\-password\fP \fIpassword\fP]
[\fB\-\-proxyserver\fP \fIport\fP]
[\fB\-\-proxyclient\fP \fIserver\fP]
.SH DESCRIPTION
.SH DESCRIPTION
Runs an OpenDHT node, with a CLI (default) or as a daemon (with \fB'-d'\fP or \fB'-s'\fP).
This program runs a simple OpenDHT node in an interactive way. If you rather
Commands available in the interactive shell are:
want to run the node in daemon mode, option \fB'-d'\fP is provided. When running
in the interactive shell, you benefit from the readline capabilities for writing
your commands such as command history. Here are the available commands in the
interactive shell:
.EE
.EE
h, help Print this help message.
h, help Print this help message.
q, quit Quit the program.
q, quit Quit the program.
...
@@ -37,75 +40,63 @@ interactive shell:
...
@@ -37,75 +40,63 @@ interactive shell:
private key.
private key.
e [key] [dest] [str] Put string value at [key], encrypted for [dest] with
e [key] [dest] [str] Put string value at [key], encrypted for [dest] with
its public key (if found).
its public key (if found).
.SH OPTIONS
.SH OPTIONS
.TP
.TP
\fB-h\fP
\fB
\
-h\fP
Prints some help.
Prints some help.
.TP
.TP
\fB-v\fP
\fB\-v\fP
Enable the verbose mode (log to stdout by default)
Enable the verbose mode (log to stdout/stderr by default)
.TP
.TP
\fB-l\fP \fIlog_file\fP
\fB\-l\fP \fIlog_file\fP
Write log to file instead of stdout
Write log to file instead of stdout/stderr
.TP
.TP
\fB-L\fP
\fB\-L\fP
Write log to syslog instead of stdout
Write log to syslog instead of stdout/stderr
.TP
.TP
\fB-i\fP
\fB
\
-i\fP
Generate cryptographic identity for the node.
Generate cryptographic identity for the node.
.TP
.TP
\fB
-
-save-identity\fP \fIfile\fP
\fB
\-\
-save
\
-identity\fP \fIfile\fP
Save generated identity (certificate and private key) to given file prefix.
Save generated identity (certificate and private key) to given file prefix.
.TP
.TP
\fB
-
-certificate\fP \fIfile\fP
\fB
\-\
-certificate\fP \fIfile\fP
Load identity certificate from given file.
Load identity certificate from given file.
.TP
.TP
\fB
-
-privkey\fP \fIfile\fP
\fB
\-\
-privkey\fP \fIfile\fP
Load identity private key from given file.
Load identity private key from given file.
.TP
.TP
\fB
-
-privkey-password\fP \fIpassword\fP
\fB
\-\
-privkey
\
-password\fP \fIpassword\fP
Password to use for private key encryption or decryption (optional).
Password to use for private key encryption or decryption (optional).
.TP
.TP
\fB-d\fP
\fB
\
-d\fP
Run the program in daemon mode (will fork in the background).
Run the program in daemon mode (will fork in the background).
.TP
.TP
\fB-s\fP
\fB\-s\fP
Run the program in service mode (non-forking daemon).
Run the program in service mode (non\-forking daemon).
.TP
.TP
\fB-D\fP
\fB
\
-D\fP
Enables multicast automatic local peer discovery.
Enables multicast automatic local peer discovery.
.TP
.TP
\fB-f\fP \fIfile\fP
\fB
\
-f\fP \fIfile\fP
Specify a file path to persist/load the node state.
Specify a file path to persist/load the node state.
.TP
.TP
\fB-n\fP \fInetwork_id\fP
\fB
\
-n\fP \fInetwork_id\fP
Specify the network id. This let you connect to distinct networks and prevents
Specify the network id. This let you connect to distinct networks and prevents
the merge of two different networks (available since OpenDHT v0.6.1).
the merge of two different networks (available since OpenDHT v0.6.1).
.TP
.TP
\fB-p\fP \fIlocal_port\fP
\fB
\
-p\fP \fIlocal_port\fP
Use UDP port \fIlocal_port\fP for the program to bind to.
Use UDP port \fIlocal_port\fP for the program to bind to.
.TP
.TP
\fB-b\fP \fIbootstrap_host\fP[:\fIport\fP]
\fB
\
-b\fP \fIbootstrap_host\fP[:\fIport\fP]
The program needs to be given a node to connect to the network. You use this
The program needs to be given a node to connect to the network. You use this
option to provide the ip address of that node.
option to provide the ip address of that node.
.TP
\fB\-\-proxyserver\fP \fIlocal_port\fP
Run a proxy server bound to this DHT node on HTTP port \fIlocal_port\fP
.TP
\fB\-\-proxyclient\fP \fIserver\fP
Run this DHT node in proxy client mode, and connect to \fIserver\fP
.SH AUTHORS
.SH AUTHORS
.TP
.TP
Program written by
Program written by
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment