mirror of https://github.com/ergochat/ergo.git
update manualmd
This commit is contained in:
mogad0n
parent
02096134e4
commit
de3faedec4
102
docs/MANUAL.md
102
docs/MANUAL.md
|
|
@ -14,43 +14,48 @@ _Copyright © Daniel Oaks <daniel@danieloaks.net>, Shivaram Lingamneni <slingamn
|
||||||
--------------------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
# Table of Contents
|
Table of Contents
|
||||||
|
|
||||||
- Introduction
|
|
||||||
- Project Basics
|
|
||||||
- Scalability
|
|
||||||
- Installing
|
|
||||||
- Windows
|
|
||||||
- macOS / Linux / Raspberry Pi
|
|
||||||
- Docker
|
|
||||||
- Becoming an operator
|
|
||||||
- Productionizing
|
|
||||||
- Upgrading
|
|
||||||
- Features
|
|
||||||
- User Accounts
|
|
||||||
- Nickname reservation
|
|
||||||
- Email verification
|
|
||||||
- Channel Registration
|
|
||||||
- Language
|
|
||||||
- Multiclient ("Bouncer")
|
|
||||||
- History
|
|
||||||
- IP cloaking
|
|
||||||
- Moderation
|
|
||||||
- Frequently Asked Questions
|
|
||||||
- IRC over TLS
|
|
||||||
- Modes
|
|
||||||
- User Modes
|
|
||||||
- Channel Modes
|
|
||||||
- Channel Prefixes
|
|
||||||
- Client certificates
|
|
||||||
- Commands
|
|
||||||
- Working with other software
|
|
||||||
- Kiwi IRC
|
|
||||||
- HOPM
|
|
||||||
- Tor
|
|
||||||
- External authentication systems
|
|
||||||
- Acknowledgements
|
|
||||||
|
|
||||||
|
- [Introduction](#introduction)
|
||||||
|
- [Project Basics](#project-basics)
|
||||||
|
- [Scalability](#scalability)
|
||||||
|
- [Installing](#installing)
|
||||||
|
- [Windows](#windows)
|
||||||
|
- [macOS / Linux / Raspberry Pi](#macos--linux--raspberry-pi)
|
||||||
|
- [Docker](#docker)
|
||||||
|
- [Becoming an operator](#becoming-an-operator)
|
||||||
|
- [Productionizing](#productionizing)
|
||||||
|
- [Upgrading to a new version of Oragono](#upgrading-to-a-new-version-of-oragono)
|
||||||
|
- [Features](#features)
|
||||||
|
- [User Accounts](#user-accounts)
|
||||||
|
- [Account/Nick Modes](#accountnick-modes)
|
||||||
|
- [Traditional / lenient mode](#tradiotional--lenient-mode)
|
||||||
|
- [Nick ownership](#nick-ownership)
|
||||||
|
- [SASL-only mode](#sasl-only-mode)
|
||||||
|
- [Email verification](#email-verification)
|
||||||
|
- [Channel Registration](#channel-registration)
|
||||||
|
- [Language](#language)
|
||||||
|
- [Multiclient ("Bouncer")](#multiclient-bouncer)
|
||||||
|
- [History](#history)
|
||||||
|
- [IP cloaking](#ip-cloaking)
|
||||||
|
- [Moderation](#moderation)
|
||||||
|
- [Frequently Asked Questions](#frequently-asked-questions)
|
||||||
|
- [IRC over TLS](#irc-over-tls)
|
||||||
|
- [Redirect from plaintext to TLS](#how-can-i-redirect-users-from-plaintext-to-tls)
|
||||||
|
- [Reverse proxies](#reverse-proxies)
|
||||||
|
- [Client certificates](#client-certificates)
|
||||||
|
- [Modes](#modes)
|
||||||
|
- [User Modes](#user-modes)
|
||||||
|
- [Channel Modes](#channel-modes)
|
||||||
|
- [Channel Prefixes](#channel-prefixes)
|
||||||
|
- [Commands](#commands)
|
||||||
|
- [Working with other software](#working-with-other-software)
|
||||||
|
- [Kiwi IRC](#kiwi-irc)
|
||||||
|
- [HOPM](#hopm)
|
||||||
|
- [Tor](#tor)
|
||||||
|
- [ZNC](#znc)
|
||||||
|
- [External authentication systems](#external-authentication-systems)
|
||||||
|
- [Acknowledgements](#acknowledgements)
|
||||||
|
|
||||||
--------------------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
@ -505,6 +510,10 @@ In this section, we give an overview of the modes Oragono supports.
|
||||||
|
|
||||||
These are the modes which can be set on you when you're connected.
|
These are the modes which can be set on you when you're connected.
|
||||||
|
|
||||||
|
### +a - Away
|
||||||
|
|
||||||
|
If this mode is set, you're marked as being away. This mode is set with the /AWAY command.
|
||||||
|
|
||||||
### +i - Invisible
|
### +i - Invisible
|
||||||
|
|
||||||
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).
|
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
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
### +B - Bot
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
/WHOIS Bot
|
||||||
|
|
||||||
|
will return an extra response of `RPL_WHOISBOT` with the numeric `335` which can be used to identify said Bot.
|
||||||
|
|
||||||
|
### +T - No CTCPs
|
||||||
|
|
||||||
|
If this mode is set, you will not recieve CTCP messages.
|
||||||
|
|
||||||
|
To set this mode on yourself:
|
||||||
|
|
||||||
|
/mode dan +T
|
||||||
|
|
||||||
|
To unset this mode and recieve CTCP messages:
|
||||||
|
|
||||||
|
/mode dan -T
|
||||||
|
|
||||||
## Channel Modes
|
## Channel Modes
|
||||||
|
|
||||||
These are the modes that can be set on channels when you're an oper!
|
These are the modes that can be set on channels when you're a channel operator!
|
||||||
|
|
||||||
### +b - Ban
|
### +b - Ban
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue