meowy-webring/docs/meowy-cli.1
2024-05-06 00:20:59 +01:00

42 lines
842 B
Groff

.\" Manpage for meowy-cli
.TH man 1 "05 May 2024" "0.1.0" "meowy-cli man page"
.SH NAME
meowy-cli \- configure the entries in the meowy-webring sites list
.SH SYNOPSIS
meowy-cli [options] <command>
.SH DESCRIPTION
meowy-cli is a program for adding and removing entries in the list of URLs used by the meowy-webring webring software
.SH OPTIONS
.TP
.B -p, --path <PATH>
The path to the names.json file
.TP
.B -s, --separator <SEPARATOR>
A separator string to separate the URL from the name. Defaults to ": ".
.TP
.B -h, --help
Print help
.TP
.B -v, --version
Print version
.SH SUBCOMMANDS
.TP
.B print
Print the current webring sites and their names
.TP
.B add
Add a site to the webring
.TP
.B remove
Remove a site from the webring
.TP
.B help
Print the output of -h or the help of the given subcommand(s)
.SH EXIT STATUS
.TP
.B
0
Success