Browse Source

update manualmd

tags/v2.4.0-rc1
mogad0n 3 years ago
parent
commit
de3faedec4
1 changed files with 66 additions and 38 deletions
  1. 66
    38
      docs/MANUAL.md

+ 66
- 38
docs/MANUAL.md View File

@@ -14,43 +14,48 @@ _Copyright © Daniel Oaks <daniel@danieloaks.net>, Shivaram Lingamneni <slingamn
14 14
 --------------------------------------------------------------------------------------------
15 15
 
16 16
 
17
-# Table of Contents
18
-
19
-- Introduction
20
-    - Project Basics
21
-    - Scalability
22
-- Installing
23
-    - Windows
24
-    - macOS / Linux / Raspberry Pi
25
-    - Docker
26
-    - Becoming an operator
27
-    - Productionizing
28
-    - Upgrading
29
-- Features
30
-    - User Accounts
31
-        - Nickname reservation
32
-        - Email verification
33
-    - Channel Registration
34
-    - Language
35
-    - Multiclient ("Bouncer")
36
-    - History
37
-    - IP cloaking
38
-    - Moderation
39
-- Frequently Asked Questions
40
-- IRC over TLS
41
-- Modes
42
-    - User Modes
43
-    - Channel Modes
44
-    - Channel Prefixes
45
-    - Client certificates
46
-- Commands
47
-- Working with other software
48
-    - Kiwi IRC
49
-    - HOPM
50
-    - Tor
51
-    - External authentication systems
52
-- Acknowledgements
53
-
17
+ Table of Contents
18
+
19
+- [Introduction](#introduction)
20
+    - [Project Basics](#project-basics)
21
+    - [Scalability](#scalability)
22
+- [Installing](#installing)
23
+    - [Windows](#windows)
24
+    - [macOS / Linux / Raspberry Pi](#macos--linux--raspberry-pi)
25
+    - [Docker](#docker)
26
+    - [Becoming an operator](#becoming-an-operator)
27
+    - [Productionizing](#productionizing)
28
+    - [Upgrading to a new version of Oragono](#upgrading-to-a-new-version-of-oragono)
29
+- [Features](#features)
30
+    - [User Accounts](#user-accounts)
31
+    - [Account/Nick Modes](#accountnick-modes)
32
+        - [Traditional / lenient mode](#tradiotional--lenient-mode)
33
+        - [Nick ownership](#nick-ownership)
34
+        - [SASL-only mode](#sasl-only-mode)
35
+        - [Email verification](#email-verification)
36
+    - [Channel Registration](#channel-registration)
37
+    - [Language](#language)
38
+    - [Multiclient ("Bouncer")](#multiclient-bouncer)
39
+    - [History](#history)
40
+    - [IP cloaking](#ip-cloaking)
41
+    - [Moderation](#moderation)
42
+- [Frequently Asked Questions](#frequently-asked-questions)
43
+- [IRC over TLS](#irc-over-tls)
44
+    - [Redirect from plaintext to TLS](#how-can-i-redirect-users-from-plaintext-to-tls)
45
+    - [Reverse proxies](#reverse-proxies)
46
+    - [Client certificates](#client-certificates)
47
+- [Modes](#modes)
48
+    - [User Modes](#user-modes)
49
+    - [Channel Modes](#channel-modes)
50
+    - [Channel Prefixes](#channel-prefixes)
51
+- [Commands](#commands)
52
+- [Working with other software](#working-with-other-software)
53
+    - [Kiwi IRC](#kiwi-irc)
54
+    - [HOPM](#hopm)
55
+    - [Tor](#tor)
56
+    - [ZNC](#znc)
57
+    - [External authentication systems](#external-authentication-systems)
58
+- [Acknowledgements](#acknowledgements)
54 59
 
55 60
 --------------------------------------------------------------------------------------------
56 61
 
@@ -505,6 +510,10 @@ In this section, we give an overview of the modes Oragono supports.
505 510
 
506 511
 These are the modes which can be set on you when you're connected.
507 512
 
513
+### +a - Away
514
+
515
+If this mode is set, you're marked as being away. This mode is set with the /AWAY command.
516
+
508 517
 ### +i - Invisible
509 518
 
510 519
 If this mode is set, you're marked as 'invisible'. This means that your channels won't be shown when users `/WHOIS` you (except for IRC operators, they can see all the channels you're in).
@@ -537,10 +546,29 @@ This is a special 'list mode'. If you're an IRC operator, this mode lets you see
537 546
 
538 547
 This mode is automatically set if you're connecting using SSL/TLS. There's no way to set this yourself, and it's automatically set or not set when you connect to the server.
539 548
 
549
+### +B - Bot
550
+
551
+If this mode is set, you are marked as a 'Bot'. The bot can set this mode on itself. This adds additional information in response to WHOIS
552
+
553
+    /WHOIS Bot
554
+
555
+will return an extra response of `RPL_WHOISBOT` with the numeric `335` which can be used to identify said Bot.
556
+
557
+### +T - No CTCPs
558
+
559
+If this mode is set, you will not recieve CTCP messages.
560
+
561
+To set this mode on yourself:
562
+
563
+    /mode dan +T
564
+
565
+To unset this mode and recieve CTCP messages:
566
+
567
+    /mode dan -T
540 568
 
541 569
 ## Channel Modes
542 570
 
543
-These are the modes that can be set on channels when you're an oper!
571
+These are the modes that can be set on channels when you're a channel operator!
544 572
 
545 573
 ### +b - Ban
546 574
 

Loading…
Cancel
Save