innernet/doc/innernet.8

101 lines
2.1 KiB
Groff
Raw Normal View History

2022-02-18 01:57:22 +00:00
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
2022-03-16 09:17:37 +00:00
.TH INNERNET "8" "March 2022" "innernet 1.5.4" "System Administration Utilities"
2021-04-09 13:47:33 +00:00
.SH NAME
2022-03-16 09:17:37 +00:00
innernet \- manual page for innernet 1.5.4
2021-04-09 13:47:33 +00:00
.SH DESCRIPTION
2022-03-16 09:17:37 +00:00
innernet 1.5.4
2022-01-11 20:18:19 +00:00
Jake McGinty <jake@tonari.no>
2021-04-09 13:47:33 +00:00
A client to manage innernet network interfaces.
.SS "USAGE:"
.IP
2021-05-31 15:23:14 +00:00
innernet [OPTIONS] [SUBCOMMAND]
.SS "OPTIONS:"
2022-01-11 20:18:19 +00:00
.TP
2021-05-31 15:23:14 +00:00
\fB\-v\fR, \fB\-\-verbose\fR
Verbose output, use \fB\-vv\fR for even higher verbositude
2022-01-11 20:18:19 +00:00
.TP
\fB\-c\fR, \fB\-\-config\-dir\fR <CONFIG_DIR>
2021-12-05 17:35:18 +00:00
[default: /etc/innernet]
2022-01-11 20:18:19 +00:00
.TP
\fB\-d\fR, \fB\-\-data\-dir\fR <DATA_DIR>
2021-12-05 17:35:18 +00:00
[default: /var/lib/innernet]
2022-01-11 20:18:19 +00:00
.TP
2021-05-19 07:59:27 +00:00
\fB\-\-no\-routing\fR
2022-01-11 20:18:19 +00:00
Whether the routing should be done by innernet or is done by an
external tool like e.g. babeld
.TP
\fB\-\-backend\fR <BACKEND>
Specify a WireGuard backend to use. If not set, innernet will
auto\-select based on availability [default: kernel] [possible
values: kernel, userspace]
.TP
\fB\-\-mtu\fR <MTU>
2022-03-15 02:15:56 +00:00
Specify the desired MTU for your interface (default: 1280)
2022-01-11 20:18:19 +00:00
.TP
2021-05-31 15:23:14 +00:00
\fB\-h\fR, \fB\-\-help\fR
2022-01-11 20:18:19 +00:00
Print help information
.TP
2021-05-31 15:23:14 +00:00
\fB\-V\fR, \fB\-\-version\fR
2022-01-11 20:18:19 +00:00
Print version information
2021-04-09 13:47:33 +00:00
.SS "SUBCOMMANDS:"
.TP
2021-05-31 15:23:14 +00:00
install
Install a new innernet config
2021-04-09 13:47:33 +00:00
.TP
2021-05-31 15:23:14 +00:00
show
Enumerate all innernet connections
.TP
up
Bring up your local interface, and update it with latest peer list
.TP
fetch
Fetch and update your local interface with the latest peer list
.TP
uninstall
Uninstall an innernet network
.TP
down
2021-11-11 09:42:21 +00:00
Bring down the interface (equivalent to 'wg\-quick down <interface>')
2021-04-09 13:47:33 +00:00
.TP
add\-peer
Add a new peer
.TP
2021-05-31 15:23:14 +00:00
rename\-peer
Rename a peer
.TP
add\-cidr
Add a new CIDR
2021-04-09 13:47:33 +00:00
.TP
2021-05-21 05:46:30 +00:00
delete\-cidr
Delete a CIDR
.TP
2021-06-14 14:53:02 +00:00
list\-cidrs
List CIDRs
.TP
2021-04-09 13:47:33 +00:00
disable\-peer
Disable an enabled peer
.TP
enable\-peer
Enable a disabled peer
.TP
2021-05-31 15:23:14 +00:00
add\-association
Add an association between CIDRs
2021-04-09 13:47:33 +00:00
.TP
2021-05-31 15:23:14 +00:00
delete\-association
Delete an association between CIDRs
2021-04-09 13:47:33 +00:00
.TP
list\-associations
List existing assocations between CIDRs
.TP
set\-listen\-port
Set the local listen port
.TP
2021-05-31 15:23:14 +00:00
override\-endpoint
Override your external endpoint that the server sends to other peers
2021-04-09 13:47:33 +00:00
.TP
2021-05-31 15:23:14 +00:00
completions
Generate shell completion scripts
2021-04-09 13:47:33 +00:00
.TP
2021-05-31 15:23:14 +00:00
help
2022-01-11 20:18:19 +00:00
Print this message or the help of the given subcommand(s)