Files
cunicu/docs/usage/man/cunicu-status.1
Steffen Vogel 26ae073578 docs: update command usage information
Signed-off-by: Steffen Vogel <post@steffenvogel.de>
2022-09-10 02:56:47 +02:00

58 lines
1.0 KiB
Groff

.nh
.TH "cunīcu" "1" "Sep 2022" "https://github.com/stv0g/cunicu" ""
.SH NAME
.PP
cunicu-status - Show current status of the cunīcu daemon, its interfaces and peers
.SH SYNOPSIS
.PP
\fBcunicu status [interface-name [peer-public-key]] [flags]\fP
.SH DESCRIPTION
.PP
Show current status of the cunīcu daemon, its interfaces and peers
.SH OPTIONS
.PP
\fB-f\fP, \fB--format\fP="human"
Output \fB\fCformat\fR (one of: human, json)
.PP
\fB-h\fP, \fB--help\fP[=false]
help for status
.PP
\fB-i\fP, \fB--indent\fP[=true]
Format and indent JSON ouput
.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(1)\fP