about summary refs log tree commit diff
path: root/extra/edit/pounce-edit.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--extra/edit/pounce-edit.1123
1 files changed, 123 insertions, 0 deletions
diff --git a/extra/edit/pounce-edit.1 b/extra/edit/pounce-edit.1
new file mode 100644
index 0000000..eb66a95
--- /dev/null
+++ b/extra/edit/pounce-edit.1
@@ -0,0 +1,123 @@
+.Dd April  3, 2022
+.Dt POUNCE-EDIT 7
+.Os
+.
+.Sh NAME
+.Nm pounce-edit
+.Nd pounce configuration over IRC
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl v
+.Op Fl c Ar cert
+.Op Fl h Ar host
+.Op Fl k Ar priv
+.Op Fl p Ar port
+.Op Fl t Ar trust
+.Op Fl u Ar user
+.Op Fl w Ar pass
+.Ar config ...
+.
+.Sh DESCRIPTION
+The
+.Nm
+client provides
+.Xr pounce 1
+configuration editing
+over IRC.
+It accepts commands
+sent to the user's own nick.
+It writes its changes
+to the last configuration file
+listed on the command line.
+Configuration files
+are searched for
+in the same manner as
+.Xr pounce 1 .
+.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl c Ar cert
+Load the TLS client certificate from
+.Ar cert .
+If the private key
+is in a separate file,
+it is loaded with
+.Fl k .
+.
+.It Fl h Ar host
+Connect to
+.Ar host .
+The default is the value of
+.Cm local-host
+from the configuration files.
+.
+.It Fl p Ar port
+Connect to
+.Ar port .
+The default is the value of
+.Cm local-port
+from the configuration files,
+or 6697.
+.
+.It Fl t Ar trust
+Trust the self-signed certificate loaded from
+.Ar path
+and disable server name verification.
+.
+.It Fl u Ar user
+Set the username to
+.Ar user .
+The default username is
+.Dq pounce-edit .
+.
+.It Fl v
+Log IRC protocol to standard error.
+.
+.It Fl w Ar pass
+Log in with the server password
+.Ar pass .
+.El
+.
+.Sh COMMANDS
+Commands are sent as private messages
+to the user's own nick.
+Replies are sent as notices.
+.Bl -tag -width Ds
+.It Ic get Op Ar option
+Show the value of an option,
+or list all set options.
+.It Ic restart
+Restart
+.Xr pounce 1 .
+.It Ic set Ar option Op Ar value
+Set an option.
+.It Ic unset Ar option
+Unset an option.
+.El
+.
+.Sh FILES
+See
+.Xr pounce 1 .
+.
+.Sh EXAMPLES
+Inherit options from
+.Pa tilde.conf ,
+write changes to
+.Pa tilde.edit :
+.Bd -literal -offset indent
+$ pounce tilde.conf tilde.edit
+$ pounce-edit -c local.pem tilde.conf tilde.edit
+.Ed
+.
+.Sh AUTHORS
+.An June McEnroe Aq Mt june@causal.agency
+.
+.Sh BUGS
+Send mail to
+.Aq Mt list+pounce@causal.agency
+or join
+.Li #ascii.town
+on
+.Li irc.tilde.chat .