Reword and clarify parts of the manual

Mostly related to the utilities options.
weechat-hashes
C. McEnroe 2021-07-06 12:50:42 -04:00
parent ddb331d8dc
commit 60660a780e
1 changed files with 29 additions and 14 deletions

View File

@ -95,8 +95,13 @@ following their corresponding flags.
.It Fl C Ar util | Cm copy No = Ar util .It Fl C Ar util | Cm copy No = Ar util
Set the utility used by Set the utility used by
.Ic /copy . .Ic /copy .
Use more than once to add arguments to Subsequent
.Cm copy
options append arguments to
.Ar util . .Ar util .
The URL to copy is provided to
.Ar util
on standard input.
The default is the first available of The default is the first available of
.Xr pbcopy 1 , .Xr pbcopy 1 ,
.Xr wl-copy 1 , .Xr wl-copy 1 ,
@ -158,19 +163,27 @@ with a hash of its original value.
. .
.It Fl N Ar util | Cm notify No = Ar util .It Fl N Ar util | Cm notify No = Ar util
Send notifications using a utility. Send notifications using a utility.
Use more than once to add arguments to Subsequent
.Cm notify
options append arguments to
.Ar util . .Ar util .
Two additional arguments are passed to The window name and message
.Ar util : are provided to
a title and a description, .Ar util
as two additional arguments,
appropriate for appropriate for
.Xr notify-send 1 . .Xr notify-send 1 .
. .
.It Fl O Ar util | Cm open No = Ar util .It Fl O Ar util | Cm open No = Ar util
Set the utility used by Set the utility used by
.Ic /open . .Ic /open .
Use more than once to add arguments to Subsequent
.Cm open
options append arguments to
.Ar util . .Ar util .
The URL to open is provided to
.Ar util
as an argument.
The default is the first available of The default is the first available of
.Xr open 1 , .Xr open 1 ,
.Xr xdg-open 1 . .Xr xdg-open 1 .
@ -209,8 +222,9 @@ with
using SASL PLAIN. using SASL PLAIN.
Since this requires the account password Since this requires the account password
in plain text, in plain text,
it is recommended to use SASL EXTERNAL instead with it is recommended to use CertFP instead.
.Fl e . See
.Sx Configuring CertFP .
. .
.It Fl c Ar path | Cm cert No = Ar path .It Fl c Ar path | Cm cert No = Ar path
Load the TLS client certificate from Load the TLS client certificate from
@ -233,7 +247,7 @@ Authenticate using SASL EXTERNAL,
also known as CertFP. also known as CertFP.
The TLS client certificate is loaded with The TLS client certificate is loaded with
.Fl c . .Fl c .
For more information, see See
.Sx Configuring CertFP . .Sx Configuring CertFP .
. .
.It Fl g Ar path .It Fl g Ar path
@ -380,7 +394,8 @@ to your account:
.It .It
Enable SASL EXTERNAL Enable SASL EXTERNAL
to require successful authentication to require successful authentication
when connecting: when connecting
(not possible on all networks):
.Bd -literal -offset indent .Bd -literal -offset indent
cert = example.pem cert = example.pem
sasl-external sasl-external
@ -512,7 +527,7 @@ or temporarily add a pattern.
To permanently add a pattern, use To permanently add a pattern, use
.Fl i . .Fl i .
.It Ic /move Oo Ar name Oc Ar num .It Ic /move Oo Ar name Oc Ar num
Move named window to number. Move the named or current window to number.
.It Ic /open Op Ar count .It Ic /open Op Ar count
Open each of Open each of
.Ar count .Ar count
@ -786,7 +801,7 @@ if requested by the user,
.Dv EX_UNAVAILABLE .Dv EX_UNAVAILABLE
(69) (69)
if the connection is lost, if the connection is lost,
and >0 if an error occurs. and >0 if any other error occurs.
. .
.Sh EXAMPLES .Sh EXAMPLES
Join Join
@ -978,10 +993,10 @@ catgirl tilde
.Ss Extensions .Ss Extensions
The The
.Nm .Nm
client can take advantage of the client implements the
.Sy causal.agency/consumer .Sy causal.agency/consumer
vendor-specific IRCv3 capability vendor-specific IRCv3 capability
implemented by offered by
.Xr pounce 1 . .Xr pounce 1 .
The consumer position is stored in the The consumer position is stored in the
.Cm save .Cm save