| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 1 | .TH DSH 1 "September 2023" "Version 1.0" "Distributed Shell" |
| 2 | .SH NAME |
| 3 | dsh \- Distributed Shell |
| 4 | .SH SYNOPSIS |
| 5 | .B dsh |
| 6 | .RI "[-h|--help] [-V|--version] [-l|--listen] [-b|--bootstrap <BOOTSTRAP_ADDRESS>] [-s|--binary <BINARY_PATH>] [-I|--id_path <IDENTITY_PATH>]" |
| 7 | .RI "<PEER_ID>" |
| 8 | .SH DESCRIPTION |
| 9 | \fBdsh\fR is a Distributed Shell program that enables peers to establish connections with other peers in a Distributed Hash Table (DHT) network and execute a binary on the remote target. |
| 10 | .PP |
| 11 | \fBdsh\fR allows you to: |
| 12 | .IP |
| 13 | - Execute commands on remote peers in a DHT network. |
| 14 | - Establish connections with peers and execute binaries on their side. |
| 15 | .SH OPTIONS |
| 16 | .TP |
| 17 | .B \-h, \-\-help |
| 18 | Display help information for using \fBdsh\fR. |
| 19 | .TP |
| 20 | .B \-V, \-\-version |
| 21 | Display the version information of \fBdsh\fR. |
| 22 | .TP |
| 23 | .B \-l, \-\-listen |
| 24 | Run \fBdsh\fR in listen mode, allowing the program to accept incoming network connections and perform network-related tasks on request. |
| 25 | .TP |
| 26 | .B \-b, \-\-bootstrap <BOOTSTRAP_ADDRESS> |
| 27 | Specify the address of a bootstrap node to connect to an existing DHT network. This option requires an argument. The default value is "bootstrap.jami.net" if not specified. |
| 28 | .TP |
| 29 | .B \-s, \-\-binary <BINARY_PATH> |
| 30 | Specify the path to the binary that should be executed on the remote target when a connection is established. This option requires an argument. The default value is "bash" if not specified. |
| 31 | .TP |
| 32 | .B \-I, \-\-id_path <IDENTITY_PATH> |
| 33 | Specify the path to the identity file, which contains information about the peer's identity and is used for DHT network interactions. This option requires an argument. The default value is "~/.dhtnet" if not specified. |
| 34 | .TP |
| 35 | .B <PEER_ID> |
| 36 | The peer ID argument is required when not running in listen mode. It specifies the ID of the target peer or device in the DHT network with which the connection should be established. |
| 37 | .SH EXAMPLE |
| 38 | To connect to a remote peer and specify a custom bootstrap node, binary, and identity file, you can use the following command: |
| 39 | .PP |
| 40 | .B |
| 41 | dsh -b <BOOTSTRAP_ADDRESS> -s <BINARY_PATH> -I <IDENTITY_PATH> <PEER_ID> |
| 42 | .SH SEE ALSO |
| 43 | .PP |
| 44 | .BR dshd (1) |