mirror/Arsse
1
1
Fork 0
mirror of https://code.mensbeam.com/MensBeam/Arsse.git synced 2024-12-22 13:12:41 +00:00
Code Issues Activity

Start on an mdoc-format manual

Browse source
This commit is contained in:
J. King 2023-10-27 12:28:22 -04:00
parent 5579144fee
commit 174ed544b2
2 changed files with 88 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

88
manpages/arsse.1.en.mdoc Normal file
View file

@ -0,0 +1,88 @@
.Dd October 27, 2023
.Dt ARSSE 1
.Os "The Arsse" 0.10.4
.
.
.Sh NAME
.Nm arsse
.Nd manage an instance of The Advanced RSS Environment (The Arsse)
.
.
.Sh SYNOPSIS
.Nm "arsse user"
.Op Nm list
.Nm "arsee user add"
.Ar username
.Op Ar password
.Op Fl Fl admin
.Nm "arsse user remove"
.Ar username
.Nm "arsse user show"
.Ar username
.Nm "arsse user set"
.Ar username
.Ar property
.Ar value
.Nm "arsse user unset"
.Ar username
.Ar property
.Nm "arsse user set\-pass"
.Ar username
.Op Ar password
.Op Fl Fl fever
.Nm "arsse user unset\-pass"
.Ar username
.Op Fl Fl fever
.Nm "arsse user auth"
.Ar username
.Op Ar password
.Op Fl Fl fever
.Nm "arsse token list"
.Ar username
.Nm "arsse token create"
.Ar username
.Op Ar label
.Nm "arsse token revoke"
.Ar username
.Op Ar token
.Nm "arsse import"
.Ar username
.Op Ar file
.Op Fl f | Fl Fl flat
.Op Fl r | Fl Fl replace
.Nm "arsse export"
.Ar username
.Op Ar file
.Op Fl f | Fl Fl flat
.Nm "arsse daemon"
.Op Fl Fl fork Ns = Ns Ar pidfile
.Nm "arsse feed refresh\-all"
.Nm "arsse feed refresh"
.Ar n
.Nm "arsse conf save\-defaults"
.Nm "arsse"
.Fl Fl version | Fl h | Fl Fl help
.
.
.Sh DESCRIPTION
.Nm
allows a sufficiently privileged user to perform various administrative operations related to The Arsse, including:
.Pp
.Bl -bullet -compact
.It
Adding and removing users and managing their metadata
.It
Managing passwords and authentication tokens
.It
Importing and exporting OPML newsfeed-lists
.El
.Pp
.Sm off
These are documented in the next section
.Sx COMMANDS
\&. Further, seldom-used commands are documented in the following section
.Sx "ADDITIONAL COMMANDS"
\&.
.Sm on
.
.

4
manpages/en.groff
View file

@ -55,10 +55,6 @@ arsse \- manage an instance of The Advanced RSS Environment (The Arsse)
.RI < username > .RI < username >
.RI [< file >] .RI [< file >]
.RB [ \-f | \-\-flat ] .RB [ \-f | \-\-flat ]
.SY "arsse export"
.RI < username >
.RI [< file >]
.RB [ \-f | \-\-flat ]
.SY "arsse daemon" .SY "arsse daemon"
.RB [ \-\-fork =\c .RB [ \-\-fork =\c
.IR pidfile ] .IR pidfile ]