Projects : yrc : yrc_reindent_docs
| 1 | The yrc manual |
| 2 | |
| 3 | Version 97 Kelvin |
| 4 | Jacob Welsh |
| 5 | |
| 6 | Table of Contents |
| 7 | 1 About yrc |
| 8 | 2 Display |
| 9 | 3 Commands |
| 10 | 3.1 Slash commands |
| 11 | 3.2 Keyboard commands |
| 12 | 3.2.1 Anywhere |
| 13 | 3.2.2 In the window list |
| 14 | 3.2.3 At the prompt |
| 15 | 3.2.4 In the scrollback window |
| 16 | 4 Configuration |
| 17 | 4.1 Keys |
| 18 | 4.2 Logging |
| 19 | 4.3 Example |
| 20 | 5 Roadmap |
| 21 | 6 News and contact |
| 22 | Footnotes |
| 23 | |
| 24 | 1. About yrc |
| 25 | |
| 26 | yrc is a text-based, screen-oriented Internet Relay Chat (IRC) client providing a vital dose of simplicity in a computing world drowning in complexity. There are certain things that just shouldn't have bugs, and in the author's opinion, chat programs are among them. |
| 27 | |
| 28 | Simple does not necessarily mean "user-friendly" in the sense that you can expect to operate it without reading this manual. It does mean the literate operator should be able to read and comprehend the manual in an hour or two, and on this basis to fully grasp the workings of the program with a little practice. |
| 29 | |
| 30 | For yrc to achieve its goals, the following decisions were made: |
| 31 | |
| 32 | 1. High-level language implementation. In a network-exposed, not performance-critical application, there's just no excuse for the possibility of invoking Undefined Behavior and the ensuing vulnerabilities. |
| 33 | |
| 34 | 2. Simple configuration mechanism employing the filesystem as a hierarchical key-value database; no structured format to parse. [1] |
| 35 | |
| 36 | 3. Support exclusively VT100-compatible terminals on Unix-like systems. |
| 37 | |
| 38 | 4. No dependencies besides POSIX. [2] |
| 39 | |
| 40 | 5. No superfluous features such as mIRC colors, DCC or CTCP. [3] |
| 41 | |
| 42 | 6. No Unicode or any other flavor of hieroglyphs. Control and 8-bit characters in any IRC string are sanitized on display, both to protect the terminal and show the operator exactly what he is receiving. [4] |
| 43 | |
| 44 | 7. No SSL/TLS/TLS_1.3/whatever-they're-calling-it-today. [5] |
| 45 | |
| 46 | It does support several niceties: |
| 47 | |
| 48 | 1. Multiple message windows (separated channels/conversations) |
| 49 | |
| 50 | 2. Maintenance of connections to multiple networks, defined either by configuration or on the fly |
| 51 | |
| 52 | 3. Round-robin server balancing independent of DNS |
| 53 | |
| 54 | 4. Unlimited scrollback [6] |
| 55 | |
| 56 | 5. Basic authentication (the PASS command) |
| 57 | |
| 58 | 6. Sending raw commands to the IRC server for unsupported features |
| 59 | |
| 60 | 7. Communication of internal state to the operator: unread messages, connection state |
| 61 | |
| 62 | 8. Chat logging |
| 63 | |
| 64 | It is written in Python 2.6 (though this is an implementation detail and subject to change). Some of its more reusable terminal interface code is included as a separate "yterm" module. The yrc+yterm code weighs in around 2390 raw lines, compressing to 19KB. |
| 65 | |
| 66 | yrc is written, published and maintained by JWRD Computing ( http://jwrd.net/ ). |
| 67 | |
| 68 | 2. Display |
| 69 | |
| 70 | The yrc display is designed to maximize information and context available on a single screen, because eyes move faster than fingers. It has five parts: |
| 71 | |
| 72 | Title bar: shows a description of the current window, or the channel topic. |
| 73 | |
| 74 | Window list: an index of open windows (see below). |
| 75 | |
| 76 | Scrollback window: shows message history for a particular channel or private conversation, or server messages for a network, or general messages. |
| 77 | |
| 78 | Status bar: typically, shows the current nickname, network, and message target. |
| 79 | |
| 80 | Prompt: messages and commands are typed here. |
| 81 | |
| 82 | The window list is kept in alphabetical order, grouped by network, after the general messages window "yrc". An asterisk (*) in the first column indicates the currently selected window and a hyphen (-) the previous. Unread messages are indicated by a +N after the window name, where N is the number unread. A network's connection state is indicated by a symbol in front of its name, as follows: |
| 83 | |
| 84 | Blank: Not connected |
| 85 | |
| 86 | Tilde (~): Connection down: awaiting TCP handshake completion, or connection lost and waiting to reconnect |
| 87 | |
| 88 | Hyphen (-): TCP connection established but not registered to the server |
| 89 | |
| 90 | Equals (=): Fully registered; clear to send messages |
| 91 | |
| 92 | 3. Commands |
| 93 | |
| 94 | yrc is controlled using _slash commands_ and _keyboard commands_. Slash commands are entered at the prompt by starting the line with the forward "/" character. Most can be given as abbreviations, as indicated below. Some take one or more space-delimited arguments. To send a line starting with a slash as a normal message, use two slashes. Keyboard commands are invoked by typing special keys or key combinations. |
| 95 | |
| 96 | For interactive use, the phrases "current network" or "current channel" mean the network or channel of the currently selected window. For scripts (not yet implemented), they mean the network or channel under which the script is configured. |
| 97 | |
| 98 | 3.1. Slash commands |
| 99 | |
| 100 | [c]onnect NETWORK [HOST[:PORT] [NICK [PASS]]] |
| 101 | |
| 102 | Connect to NETWORK, either preconfigured or with the given parameters. |
| 103 | |
| 104 | [d]isconnect [NETWORK] |
| 105 | |
| 106 | Disconnect from NETWORK or the current network, or cancel a reconnection attempt. |
| 107 | |
| 108 | [j]oin CHANNEL [KEY] |
| 109 | |
| 110 | Join a channel on the current network. |
| 111 | |
| 112 | [k]ick USER [MESSAGE] |
| 113 | |
| 114 | Kick a user from the current channel. |
| 115 | |
| 116 | [l]ist [CHANNEL] |
| 117 | |
| 118 | Request a list of channels and topics, or the status of a given channel, on the current network. |
| 119 | |
| 120 | me MESSAGE |
| 121 | |
| 122 | Send MESSAGE as a CTCP ACTION (rendered by many clients in an alternate style showing the nickname as the start of a sentence). |
| 123 | |
| 124 | [m]ode MODE {[CHANNEL] | NICK [CHANNEL]} |
| 125 | |
| 126 | [TODO; uncertain...] Set a mode on CHANNEL or the current channel, or a user mode on NICK in CHANNEL or the current channel. |
| 127 | |
| 128 | msg {CHANNEL | NICK} [MESSAGE] |
| 129 | |
| 130 | Switch to the window for CHANNEL or NICK on the current network, creating one if needed, and send the given MESSAGE, if any. (This does not join a channel; messages to an unjoined channel might be rejected by the server.) |
| 131 | |
| 132 | [na]mes [CHANNEL] |
| 133 | |
| 134 | Request the list of names in the given channel, or all visible channels and users on the current network. |
| 135 | |
| 136 | [n]ick NICK |
| 137 | |
| 138 | Temporarily change nickname on the current network (persists across reconnections but not new connections). |
| 139 | |
| 140 | [p]art [PART_MESSAGE] |
| 141 | |
| 142 | Leave the current channel, keeping its window open. |
| 143 | |
| 144 | [q]uit [QUIT_MESSAGE] |
| 145 | |
| 146 | Disconnect from all networks and quit yrc. |
| 147 | |
| 148 | [s]end COMMAND |
| 149 | |
| 150 | Send a raw IRC command to the server for the current network. |
| 151 | |
| 152 | [st] set-topic TOPIC |
| 153 | |
| 154 | Set the topic for the current channel to TOPIC. |
| 155 | |
| 156 | [t]opic [CHANNEL] |
| 157 | |
| 158 | Get the topic for the current channel or the given channel on the current network. |
| 159 | |
| 160 | [w]hois NICK |
| 161 | |
| 162 | Request information on a user on the current network. |
| 163 | |
| 164 | [ww] whowas NICK |
| 165 | |
| 166 | Request cached information for a disconnected user on the current network. |
| 167 | |
| 168 | [x] close |
| 169 | |
| 170 | Close the current window, parting with no message if it is a channel. |
| 171 | |
| 172 | [xn] close-net (TODO) |
| 173 | |
| 174 | Disconnect and close all windows for the current network. |
| 175 | |
| 176 | 3.2. Keyboard commands |
| 177 | |
| 178 | In the Emacs tradition, C- means to hold Ctrl, and M- means to hold Alt (Meta). |
| 179 | |
| 180 | Some commands are multi-key sequences beginning with C-x. For these, you can either continue holding Ctrl or not. That is, C-x n is equivalent to C-x C-n. If necessary, an Alt combination can be emulated by pressing (not holding) Esc followed by the letter. Key sequences in progress are indicated in the status bar and can be cancelled with C-g. |
| 181 | |
| 182 | Each keyboard command has an associated name (used internally for key mapping and perhaps a future scripting feature). The mapping of some keys to commands depends on which part of the interface is focused. Most commands have multiple keybindings, providing a choice of Emacs, vi, or dedicated key styles. To become a more productive Unix user, it can't hurt to learn them all! |
| 183 | |
| 184 | 3.2.1. Anywhere |
| 185 | |
| 186 | C-x n: buflist-switch-next |
| 187 | |
| 188 | Switches to the next scrollback window in the list. |
| 189 | |
| 190 | C-x p: buflist-switch-prev |
| 191 | |
| 192 | Switches to the previous scrollback window in the list. |
| 193 | |
| 194 | C-x l: buflist-last-selected |
| 195 | |
| 196 | Switches to the previously active scrollback window. |
| 197 | |
| 198 | C-x w: buflist-enter |
| 199 | |
| 200 | Moves focus to the window list (see 3.2.2). |
| 201 | |
| 202 | C-l: redraw |
| 203 | |
| 204 | Performs a full redraw of the screen, e.g. in case of corruption from the output of another program. |
| 205 | |
| 206 | 3.2.2. In the window list |
| 207 | |
| 208 | C-n, j, Down: buflist-next |
| 209 | |
| 210 | Moves the cursor to the next entry in the window list. |
| 211 | |
| 212 | C-p, k, Up: buflist-prev |
| 213 | |
| 214 | Moves the cursor to the previous entry in the window list. |
| 215 | |
| 216 | h, Left: buflist-shrink |
| 217 | |
| 218 | Reduces window list width. |
| 219 | |
| 220 | l, Right: buflist-grow |
| 221 | |
| 222 | Increases window list width. |
| 223 | |
| 224 | M-<, g, Home: buflist-top |
| 225 | |
| 226 | Moves the cursor to the top of the window list. |
| 227 | |
| 228 | M->, G, End: buflist-bottom |
| 229 | |
| 230 | Moves the cursor to the bottom of the window list. |
| 231 | |
| 232 | Return (C-m): buflist-submit |
| 233 | |
| 234 | Activates the selected scrollback window and returns focus to where it was. |
| 235 | |
| 236 | 3.2.3. At the prompt |
| 237 | |
| 238 | Return (C-m): prompt-submit |
| 239 | |
| 240 | Submits the message or command given at the prompt. |
| 241 | |
| 242 | Ins: prompt-exit |
| 243 | |
| 244 | Moves focus to the scrollback window (see 3.2.4). |
| 245 | |
| 246 | C-b, Left: prompt-back |
| 247 | |
| 248 | Moves the cursor backward by one character. |
| 249 | |
| 250 | C-f, Right: prompt-forward |
| 251 | |
| 252 | Moves the cursor forward by one character. |
| 253 | |
| 254 | C-a, Home: prompt-start |
| 255 | |
| 256 | Moves the cursor to the start of the line. |
| 257 | |
| 258 | C-e, End: prompt-end |
| 259 | |
| 260 | Moves the cursor to the end of the line. |
| 261 | |
| 262 | M-b, prompt-back-word |
| 263 | |
| 264 | Moves the cursor to the start of the current word, or preceeding word if not currently in one. |
| 265 | |
| 266 | M-f, prompt-forward-word |
| 267 | |
| 268 | Moves the cursor past the end of the current word, or following word if not currently in one. |
| 269 | |
| 270 | C-p, Up: history-prev |
| 271 | |
| 272 | Recalls a previous line from input history. (History size is currently fixed at 1024 most recent entries.) |
| 273 | |
| 274 | C-n, Down: history-next |
| 275 | |
| 276 | Recalls a subsequent line from input history, discarding any unsubmitted edits to a previous line. |
| 277 | |
| 278 | Backspace (C-h, C-?): prompt-backspace |
| 279 | |
| 280 | Deletes backward by one character. |
| 281 | |
| 282 | C-d, Del: prompt-delete |
| 283 | |
| 284 | Deletes forward by one character. |
| 285 | |
| 286 | C-u: kill-start |
| 287 | |
| 288 | Deletes text from start of line to cursor, saving it to the kill ring. (Kill ring size is currently fixed at 8 entries.) |
| 289 | |
| 290 | C-k: kill-end |
| 291 | |
| 292 | Deletes text from cursor to end of line, saving it to the kill ring. |
| 293 | |
| 294 | M-Backspace: kill-back-word |
| 295 | |
| 296 | Deletes text from cursor to start of current or preceeding word, saving it to the kill ring. Multiple kills in a row accumulate into a single entry, allowing the span to be pasted as a whole. |
| 297 | |
| 298 | M-d: kill-forward-word |
| 299 | |
| 300 | Deletes text from cursor to end of current or following word, saving it to the kill ring. |
| 301 | |
| 302 | C-y: yank |
| 303 | |
| 304 | Inserts ("yanks" or "pastes") the most recent kill ring entry at cursor position. |
| 305 | |
| 306 | M-y: yank-next |
| 307 | |
| 308 | Following a yank, replaces the just-inserted text with the next older entry in the kill ring. |
| 309 | |
| 310 | C-v, PgDn: scroll-down-page |
| 311 | M-v, PgUp: scroll-up-page |
| 312 | |
| 313 | Scrolls the active scrollback window. |
| 314 | |
| 315 | M-<: scroll-top |
| 316 | M->: scroll-bottom |
| 317 | |
| 318 | Scrolls the active scrollback window to the top or bottom. |
| 319 | |
| 320 | 3.2.4. In the scrollback window |
| 321 | |
| 322 | If the window is scrolled to the bottom (the last available message is fully visible), it will autoscroll as new messages arrive. |
| 323 | |
| 324 | i, Ins: prompt-enter |
| 325 | |
| 326 | Moves focus to the prompt (see 3.2.3). |
| 327 | |
| 328 | C-v, C-f, f, PgDn, Space: scroll-down-page |
| 329 | M-v, C-b, b, PgUp: scroll-up-page |
| 330 | |
| 331 | Scrolls the window down or up by a page. |
| 332 | |
| 333 | C-n, j, Down: scroll-down-line |
| 334 | C-p, k, Up: scroll-up-line |
| 335 | |
| 336 | Scrolls the window down or up by one wrapped line. |
| 337 | |
| 338 | M-<, g, Home: scroll-top |
| 339 | M->, G, End: scroll-bottom |
| 340 | |
| 341 | Scrolls to the top or bottom. |
| 342 | |
| 343 | 4. Configuration |
| 344 | |
| 345 | As mentioned above, yrc is configured using the filesystem as a key-value store. The config tree is rooted at ~/.yrc (the hidden directory ".yrc" under your home directory), known as the yrc home. Each config key is represented by a text file; trailing linefeeds are stripped. |
| 346 | |
| 347 | Under the yrc home may be a "nets" subdirectory. IRC networks are defined by creating further subdirectories under "nets" with names of your choice; these names are used for NETWORK in the yrc commands. |
| 348 | |
| 349 | 4.1. Keys |
| 350 | |
| 351 | The following keys may be defined at top level (directly in the yrc home) or per network, with network level taking precedence. |
| 352 | |
| 353 | addrs -- one or more server addresses (required) |
| 354 | nick -- initial IRC nickname (required) |
| 355 | pass -- plain-text password to send on connect |
| 356 | |
| 357 | Addresses are specified one per line as either hostname or IPv4 address optionally followed by ":" and port number. Lines starting with the "#" character are ignored. Per common practice, the default port is 6667. On initial connection to a network, a server is selected at random; subsequent reconnections by the same process rotate sequentially through the list. |
| 358 | |
| 359 | 4.2. Logging |
| 360 | |
| 361 | A "logs" tree is created automatically under the yrc home with subdirectories for each network. Messages associated with chats are appended to log files under these, named by VENUE.log where VENUE is the channel name or correspondent nick, casefolded and %-encoded for problematic characters. [7] To suppress logging for a particular entity, you could symlink its log file to /dev/null. |
| 362 | |
| 363 | yrc behaves as if each log file is opened fresh on each write, in the sense that deleting, truncating, renaming or linking log files works immediately and as expected. [8] yrc attempts to write each message with a single system call, so concurrent processes should be safe, though not recommended. |
| 364 | |
| 365 | The log format, designed for a degree of human and machine readability, is one message per line with the following single-space-delimited fields: |
| 366 | |
| 367 | timestamp -- decimal integer, centiseconds since the epoch |
| 368 | type -- mostly matching the IRC protocol but with some variation; consult the "message" variant type in yrc.py for details |
| 369 | sender -- quoted in <angle brackets> for aesthetics |
| 370 | content -- running to end of line |
| 371 | |
| 372 | Note that unlike in the UI, message content is not escaped; the only characters excluded by protocol are ASCII NUL, CR and LF. Thus printing a log directly to terminal (as opposed to using an editor or "less") can cause unexpected and possibly dangerous behavior. |
| 373 | |
| 374 | 4.3. Example |
| 375 | |
| 376 | An example tree, including some planned keys not yet implemented: |
| 377 | |
| 378 | ~/.yrc |
| 379 | |-- nets |
| 380 | | |-- net1 |
| 381 | | | |-- auto |
| 382 | | | |-- addrs |
| 383 | | | |-- nick |
| 384 | | | |-- pass |
| 385 | | | |-- chans |
| 386 | | | | `-- #somechan |
| 387 | | | | |-- auto |
| 388 | | | | `-- key |
| 389 | | | `-- contacts |
| 390 | | | `-- buddy |
| 391 | | `-- net2 |
| 392 | | `-- addrs |
| 393 | |-- nick |
| 394 | |-- realname |
| 395 | |-- user |
| 396 | `-- logs |
| 397 | |-- net1 |
| 398 | | |-- buddy.log |
| 399 | | `-- #channel.log |
| 400 | `-- net2 |
| 401 | `-- 1337%2Fhax0r%0A.log |
| 402 | |
| 403 | 5. Roadmap |
| 404 | |
| 405 | High-priority missing features: |
| 406 | |
| 407 | - Tab completion (nicks, slash commands) |
| 408 | - Finish mode/op and close-net commands |
| 409 | - Scrolling in window list if it exceeds available screen rows |
| 410 | - More accurate derivation of message length limit to reduce overly-conservative wrapping |
| 411 | |
| 412 | Nice to have: |
| 413 | |
| 414 | - Indication of nick mentions (ring bell + bold the window name?) |
| 415 | - Formatting for displayed messages (e.g. bold sender, highlight own nick) |
| 416 | - Filtering of inbound PMs (/ignore or similar) |
| 417 | - More efficient navigation of window list |
| 418 | - Search in scrollback |
| 419 | - Nickname fallback |
| 420 | - Online /help command |
| 421 | - Auto-connect/join or scripting |
| 422 | - Parse WHOIS/WHOWAS/LIST responses |
| 423 | - Bracketed paste [meh, not all it's cracked up to be] |
| 424 | - Date change messages |
| 425 | - Channel join status indicators |
| 426 | - Finish config fields [?] |
| 427 | |
| 428 | 6. News and contact |
| 429 | |
| 430 | News can be found in the yrc category on the author's blog: http://fixpoint.welshcomputing.com/category/software/yrc/ |
| 431 | |
| 432 | Questions/comments can be left on articles there or by visiting #fixpoint on Freenode. |
| 433 | |
| 434 | Footnotes |
| 435 | |
| 436 | [1] Inspired by DJB software, http://cr.yp.to/. |
| 437 | |
| 438 | [2] Not even "ncurses", a lesson learned from the first implementation. It's a mess. |
| 439 | |
| 440 | [3] With the possible exception of CTCP ACTION (the /me command) due to its popularity. |
| 441 | |
| 442 | [4] Contrary to presently popular opinion, this does not preclude non-English communication. It's simpler, and probably healthier, for people to learn "pinyin"/transliteration systems to a single alphabet, than to have every program pretend to support some Consortium's never-finished Babel of an infinite alphabet and all the related landmines. Double-width characters in fixed-width fonts; bidirectionality; combining ligatures, diacritics, and canonicalization thereof; surrogate escapes; multiple types of spaces; characters that look the same but aren't; non-standard private mappings; variable length encodings; byte orderings; decode error handling; glyph substitution because no single font designer can hope to provide complete coverage... are you scared yet? |
| 443 | |
| 444 | [5] Historically it's had more holes than Swiss cheese -- in design, in every major implementation -- and there's no cause to imagine that just one more patch release will fix everything. Use good cryptography if you need it, and stop deluding yourself otherwise. |
| 445 | |
| 446 | [6] Well, limited by your available memory. It would take a very busy channel indeed to make a serious dent in today's memory sizes, but in such a case, you can reclaim memory by closing its specific window from time to time. |
| 447 | |
| 448 | [7] Control and 8-bit characters plus ".", "/" and "%"; this does not include various shell metacharacters. |
| 449 | |
| 450 | [8] Currently this is in fact the implementation, which may result in interface lag e.g. on network filesystems. FD caching or a separate log thread are possible remedies if anyone cares. |