mirror of
https://github.com/savoirfairelinux/opendht.git
synced 2026-11-08 04:21:51 +00:00
Jakob Haufe
7baee925f6
This fixes the following lintian issue:
22: warning: macro 'mF' not defined [usr/share/man/man1/dhtnode.1.gz:1]
111 lines
3.4 KiB
Groff
111 lines
3.4 KiB
Groff
.TH DHTNODE 1 2019-06-08
|
|
.SH NAME
|
|
.B dhtnode
|
|
- a simple OpenDHT command line node runner.
|
|
.SH SYNOPSIS
|
|
.B dhtnode
|
|
[\fB\-h\fR]
|
|
[\fB\-v\fR [\fB\-l\fR \fIlogfile\fR] [\fB\-L\fR]]
|
|
[\fB\-i\fR [\fB\-\-save\-identity\fR \fIfile\fR]]
|
|
[\fB\-d\fR] [\fB\-s\fR]
|
|
[\fB\-n\fR \fInetwork_id\fR]
|
|
[\fB\-p\fR \fIlocal_port\fR]
|
|
[\fB\-b\fR \fIbootstrap_host\fR[:\fIport\fR]]
|
|
[\fB\-\-certificate\fR \fIfile\fR]
|
|
[\fB\-\-privkey\fR \fIfile\fR]
|
|
[\fB\-\-privkey\-password\fR \fIpassword\fR]
|
|
[\fB\-\-proxyserver\fR \fIport\fR]
|
|
[\fB\-\-proxyclient\fR \fIserver\fR]
|
|
.SH DESCRIPTION
|
|
Runs an OpenDHT node, with a CLI (default) or as a daemon (with \fB'-d'\fP or \fB'-s'\fP).
|
|
Commands available in the interactive shell are:
|
|
.EX
|
|
h, help Print this help message.
|
|
q, quit Quit the program.
|
|
log Start/stop printing DHT logs.
|
|
|
|
Node information:
|
|
ll Print basic information and stats about the current node.
|
|
ls Print basic information about current searches.
|
|
ld Print basic information about currenty stored values on this node.
|
|
lr Print the full current routing table of this node
|
|
|
|
Operations on the DHT:
|
|
b ip:port Ping potential node at given IP address/port.
|
|
g [key] Get values at [key].
|
|
l [key] Listen for value changes at [key].
|
|
p [key] [str] Put string value at [key].
|
|
s [key] [str] Put string value at [key], signed with our generated
|
|
private key.
|
|
e [key] [dest] [str] Put string value at [key], encrypted for [dest] with
|
|
its public key (if found).
|
|
.EE
|
|
.SH OPTIONS
|
|
.TP
|
|
\fB\-h\fP
|
|
Prints some help.
|
|
.TP
|
|
\fB\-v\fP
|
|
Enable the verbose mode (log to stdout/stderr by default)
|
|
.TP
|
|
\fB\-l\fP \fIlog_file\fP
|
|
Write log to file instead of stdout/stderr
|
|
.TP
|
|
\fB\-L\fP
|
|
Write log to syslog instead of stdout/stderr
|
|
.TP
|
|
\fB\-i\fP
|
|
Generate cryptographic identity for the node.
|
|
.TP
|
|
\fB\-\-save\-identity\fP \fIfile\fP
|
|
Save generated identity (certificate and private key) to given file prefix.
|
|
.TP
|
|
\fB\-\-certificate\fP \fIfile\fP
|
|
Load identity certificate from given file.
|
|
.TP
|
|
\fB\-\-privkey\fP \fIfile\fP
|
|
Load identity private key from given file.
|
|
.TP
|
|
\fB\-\-privkey\-password\fP \fIpassword\fP
|
|
Password to use for private key encryption or decryption (optional).
|
|
.TP
|
|
\fB\-d\fP
|
|
Run the program in daemon mode (will fork in the background).
|
|
.TP
|
|
\fB\-s\fP
|
|
Run the program in service mode (non\-forking daemon).
|
|
.TP
|
|
\fB\-D\fP
|
|
Enables multicast automatic local peer discovery.
|
|
.TP
|
|
\fB\-f\fP \fIfile\fP
|
|
Specify a file path to persist/load the node state.
|
|
.TP
|
|
\fB\-n\fP \fInetwork_id\fP
|
|
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).
|
|
.TP
|
|
\fB\-p\fP \fIlocal_port\fP
|
|
Use UDP port \fIlocal_port\fP for the program to bind to.
|
|
.TP
|
|
\fB\-b\fP \fIbootstrap_host\fP[:\fIport\fP]
|
|
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.
|
|
.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
|
|
.TP
|
|
Program written by
|
|
.IP \(bu
|
|
.\}
|
|
Adrien Béraud <adrien.beraud@savoirfairelinux.com>
|
|
.TP
|
|
Man page written by
|
|
.IP \(bu
|
|
.\}
|
|
Simon Désaulniers <sim.desaulniers@gmail.com>
|