summary refs log tree commit diff
path: root/pounce-edit.1
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2022-06-18 10:03:57 -0400
committerJune McEnroe <june@causal.agency>2022-06-18 10:03:57 -0400
commit511f999dfab4fce8d31af9c388d616ce45a88398 (patch)
treecb96078d99295f62b1d25af3329b84ac2897df04 /pounce-edit.1
parentedit: Validate size is power of two (diff)
downloadpounce-511f999dfab4fce8d31af9c388d616ce45a88398.tar.gz
pounce-511f999dfab4fce8d31af9c388d616ce45a88398.zip
Flatten extras to top-level directory
Diffstat (limited to 'pounce-edit.1')
-rw-r--r--pounce-edit.1133
1 files changed, 133 insertions, 0 deletions
diff --git a/pounce-edit.1 b/pounce-edit.1
new file mode 100644
index 0000000..36c59aa
--- /dev/null
+++ b/pounce-edit.1
@@ -0,0 +1,133 @@
+.Dd April  3, 2022
+.Dt POUNCE-EDIT 7
+.Os
+.
+.Sh NAME
+.Nm pounce-edit
+.Nd pounce configuration over IRC
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl av
+.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.
+Changes do not take effect until
+.Xr pounce 1
+is restarted.
+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 a
+Allow setting all options,
+including those that
+may render
+.Xr pounce 1
+inoperable.
+.
+.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 .
21-06-18Document channel keys in join optionJune McEnroe 2021-06-18Use | to separate flags from config optionsJune McEnroe This lets mandoc generate tags for the option names as well, so you can ":t away" in less(1), for example, and anchor links in HTML output. The added No's prevent the equals signs from being part of the anchor links. 2021-06-18Stop referring to server-time as IRCv3.2June McEnroe IRCv3 has moved away from grouping specs together into versions like this. SASL is still referred to as IRCv3.2 because there are two different versions of that spec. 2021-06-17Add mailing list archive to READMEJune McEnroe 2021-06-10Stop accumulating ISUPPORT tokens once MOTD startsJune McEnroe This avoids duplicating tokens when a client sends VERSION and the server responds with its 005s again. 2021-06-09Use seprintf for snip, removing strlcpynJune McEnroe 2021-06-09Use seprintf for reserializeJune McEnroe 2021-06-09Use seprintf for capListJune McEnroe 2021-06-09Add seprintfJune McEnroe Based on seprint(2) from Plan 9. I'm not sure if my return value exactly matches Plan 9's in the case of truncation. seprint(2) is described only as returning a pointer to the terminating '\0', but if it does so even in the case of truncation, it is awkward for the caller to detect. This implementation returns end in the truncation case, so that (ptr == end) indicates truncation. 2021-05-27Add pounce-notify to README 2.4June McEnroe 2021-05-27Fix ENVIRONMENT formatting in pounce-notify(1)June McEnroe 2021-05-27Add note about Libera.Chat SASL-only rangesJune McEnroe 2021-05-25Add QUIRKS fileJune McEnroe 2021-05-19Replace freenode with tilde.chatJune McEnroe 2021-05-04notify: Reword pounce-notify manualJune McEnroe 2021-05-02Clean up Makefiles, configure scriptsJune McEnroe Default MANDIR to ${PREFIX}/man since it turns out man-db includes /usr/local/man by default. Add support for BINDIR. Separate libs out into LDADD variables. 2021-04-30palaver: Exit on getopt failureJune McEnroe Oops. 2021-04-30notify: Implement pounce-notifyJune McEnroe