mirror of
https://codeberg.org/cunicu/cunicu.git
synced 2025-10-05 08:47:03 +08:00
67 lines
2.0 KiB
Groff
67 lines
2.0 KiB
Groff
.nh
|
|
.TH "cunīcu" "1" "Sep 2022" "https://github.com/stv0g/cunicu" ""
|
|
|
|
.SH NAME
|
|
.PP
|
|
cunicu-wg-show - Shows current WireGuard configuration and runtime information of specified [interface].
|
|
|
|
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\fBcunicu wg show { interface-name | all | interfaces } [{ public-key | private-key | listen-port | fwmark | peers | preshared-keys | endpoints | allowed-ips | latest-handshakes | transfer | persistent-keepalive | dump }] [flags]\fP
|
|
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
Shows current WireGuard configuration and runtime information of specified [interface].
|
|
|
|
.PP
|
|
If no [interface] is specified, [interface] defaults to 'all'.
|
|
|
|
.PP
|
|
If 'interfaces' is specified, prints a list of all WireGuard interfaces, one per line, and quits.
|
|
|
|
.PP
|
|
If no options are given after the interface specification, then prints a list of all attributes in a visually pleasing way meant for the terminal.
|
|
Otherwise, prints specified information grouped by newlines and tabs, meant to be used in scripts.
|
|
|
|
.PP
|
|
For this script-friendly display, if 'all' is specified, then the first field for all categories of information is the interface name.
|
|
|
|
.PP
|
|
If 'dump' is specified, then several lines are printed; the first contains in order separated by tab: private-key, public-key, listen-port, fwmark.
|
|
Subsequent lines are printed for each peer and contain in order separated by tab: public-key, preshared-key, endpoint, allowed-ips, latest-handshake, transfer-rx, transfer-tx, persistent-keepalive.
|
|
|
|
|
|
.SH OPTIONS
|
|
.PP
|
|
\fB-h\fP, \fB--help\fP[=false]
|
|
help for show
|
|
|
|
.PP
|
|
\fB-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
|
|
Unix control and monitoring socket
|
|
|
|
|
|
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
|
.PP
|
|
\fB-C\fP, \fB--color\fP="auto"
|
|
Enable colorization of output (one of: auto, always, never)
|
|
|
|
.PP
|
|
\fB-l\fP, \fB--log-file\fP=""
|
|
path of a file to write logs to
|
|
|
|
.PP
|
|
\fB-d\fP, \fB--log-level\fP="info"
|
|
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
|
|
|
|
.PP
|
|
\fB-v\fP, \fB--verbose\fP=0
|
|
verbosity level
|
|
|
|
|
|
.SH SEE ALSO
|
|
.PP
|
|
\fBcunicu-wg(1)\fP
|