2023-06-14 08:49:16 +00:00
|
|
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
|
|
|
|
|
.TH INNERNET "8" "June 2023" "innernet 1.6.0" "System Administration Utilities"
|
2021-04-09 13:47:33 +00:00
|
|
|
.SH NAME
|
2023-06-14 08:49:16 +00:00
|
|
|
innernet \- manual page for innernet 1.6.0
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B innernet
|
|
|
|
|
[\fI\,OPTIONS\/\fR] [\fI\,COMMAND\/\fR]
|
2021-04-09 13:47:33 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
A client to manage innernet network interfaces.
|
2023-06-14 08:49:16 +00:00
|
|
|
.SS "Commands:"
|
2021-04-09 13:47:33 +00:00
|
|
|
.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)
|
2023-06-14 08:49:16 +00:00
|
|
|
.SH OPTIONS
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-v\fR, \fB\-\-verbose\fR...
|
|
|
|
|
Verbose output, use \fB\-vv\fR for even higher verbositude
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-c\fR, \fB\-\-config\-dir\fR <CONFIG_DIR>
|
|
|
|
|
[default: /etc/innernet]
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-d\fR, \fB\-\-data\-dir\fR <DATA_DIR>
|
|
|
|
|
[default: /var/lib/innernet]
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-no\-routing\fR
|
|
|
|
|
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>
|
|
|
|
|
Specify the desired MTU for your interface (default: 1280)
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
|
|
|
Print help
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-V\fR, \fB\-\-version\fR
|
|
|
|
|
Print version
|
