summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHubert Hirtz <hubert@hirtzfr.eu>2020-08-21 19:13:28 +0200
committerHubert Hirtz <hubert@hirtzfr.eu>2020-08-21 19:13:28 +0200
commit094769f9dea00497fdead8d222a0c8bc2c0f57ac (patch)
tree5b0ab9ce9a4d6f28b1f27b6537e005b94ea669e3
parentui: Blacklist dark colors for nicks (diff)
doc: Fix typos, improve wording somewhat
Diffstat (limited to '')
-rw-r--r--doc/senpai.1.scd33
-rw-r--r--doc/senpai.5.scd14
2 files changed, 25 insertions, 22 deletions
diff --git a/doc/senpai.1.scd b/doc/senpai.1.scd
index a7d70cc..6134441 100644
--- a/doc/senpai.1.scd
+++ b/doc/senpai.1.scd
@@ -43,19 +43,18 @@ The user interface of senpai consists of 4 parts. Starting from the bottom:
The *buffer list*, shows joined channels. The special buffer *home* is where
private messages and server notices are shown.
-On the row above, *input field* is where you type in messages or commands (see
-*COMMANDS*). By default, when you type a message, senpai will send a
-notification to the current channel and other will be able to know you are
-typing.
+On the row above, the *input field* is where you type in messages or commands
+(see *COMMANDS*). By default, when you type a message, senpai will inform
+others in the channel that you are typing.
On the row above, the *status line* (or... just a line if nothing is
-happening...) is where typing indicator are shown (e.g. "dan- is typing...").
+happening...) is where typing indicators are shown (e.g. "dan- is typing...").
-Finally, the *timeline* is displayed on the rest of the screen. There are
-several types of messages in the timeline:
+Finally, the *timeline* is displayed on the rest of the screen. Several types
+of messages are in the timeline:
- User messages are shown with their nicknames,
-- User actions (*/me*) are shown with an asterisk (*\**) followed by the user
+- User actions (*/me*) are shown with an asterisk (*\**) followed by the user's
nickname,
- Status messages, such as joins, parts, topics and name lists, are shown with
two dashes (*--*),
@@ -94,40 +93,40 @@ several types of messages in the timeline:
# COMMANDS
-If the user types and sends a message that starts with a slash (*/*), it will
-instead be interpreted as a command:
+If you type and send a message that starts with a slash (*/*), it will instead
+be interpreted as a command:
/_name_ argument1 argument2...
_name_ is matched case-insensitively. It can be one of the following:
*J*, *JOIN* <channel>
- Joins the given channel.
+ Join the given channel.
*PART* [channel]
Part the given channel, defaults to the current one if omitted.
*NAMES*
- Shows the member list of the current channel. Powerlevels (such as _@_ for
+ Show the member list of the current channel. Powerlevels (such as _@_ for
"operator", or _+_ for "voice") are shown in green.
*TOPIC* [topic]
- If _topic_ is omitted, shows the topic of the current channel and, if
+ If _topic_ is omitted, show the topic of the current channel and, if
available, the person who set it and the time when it has been set.
Otherwise, change the topic of the current channel to _topic_.
*MSG* <target> <content>
- Sends _content_ to _target_.
+ Send _content_ to _target_.
*R* <content>
- Reply to the last person who sent you a private message.
+ Reply to the last person who sent a private message.
*ME* <content>
- Sends a message prefixed with your nick (a user action).
+ Send a message prefixed with your nick (a user action).
*QUOTE* <raw message>
- Sends _raw message_ verbatim.
+ Send _raw message_ verbatim.
# SEE ALSO
diff --git a/doc/senpai.5.scd b/doc/senpai.5.scd
index a9153b5..60a02ca 100644
--- a/doc/senpai.5.scd
+++ b/doc/senpai.5.scd
@@ -14,8 +14,8 @@ Some settings are required, the others are optional.
*addr* (required)
The address (_host:port_) of the IRC server. senpai only supports TLS
- connections and thus the user must specify the TLS port of the server (in
- most cases, 6697 or 7000).
+ connections and thus you must specify the TLS port of the server (in most
+ cases, 6697 or 7000).
*nick* (required)
Your nickname, sent with a _NICK_ IRC message. It mustn't contain spaces or
@@ -37,8 +37,8 @@ Some settings are required, the others are optional.
when said by others. By default, senpai will use your current nickname.
*on-highlight*
- A command to be executed via _sh_ when the user is highlighted. The
- following format specifiers are expanded with respect to the highlight:
+ A command to be executed via _sh_ when you are highlighted. The following
+ format specifiers are expanded with respect to the highlight:
[[ *Format specifier*
:< *Description*
@@ -46,6 +46,8 @@ Some settings are required, the others are optional.
: literal %
| %b
: buffer where the message appeared
+| %h
+: equals 1 if _%b_ is the current buffer, 0 otherwise
| %m
: content of the message
| %n
@@ -66,7 +68,9 @@ user: senpai
```
A more advanced configuration file that enables SASL authentication, sends
-notifications on highlight and decrease the width of the nick column to 12:
+notifications on highlight and decreases the width of the nick column to 12
+(note: _swaymsg_ is specific to sway, a wayland compositor. Use whatever you
+need to know if the terminal emulator that runs senpai has focus):
```
addr: chat.freenode.net:6697