tsr/dox
1
0
Fork 0
Code Releases Activity

more formatting

Browse Source
This commit is contained in:
traumschule 2019-01-26 11:58:14 -08:00
parent 75e798c623
commit 35226ccffd
2 changed files with 71 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
org/README.org
View File

@ -8,6 +8,7 @@ The purpose of dox is to create a git repository for the documentation we have c
for now, the file structure should be: for now, the file structure should be:
```
. .
├── css ├── css
├── html ├── html
@ -15,3 +16,4 @@ for now, the file structure should be:
├── org ├── org
└── scripts └── scripts
README.md README.md
```

110
org/irc-how-to.org
View File

@ -4,10 +4,11 @@
https://irc.anarchyplanet.org https://irc.anarchyplanet.org
*** using a client *** using a client
```
irc.anarchyplanet.org port 6667 irc.anarchyplanet.org port 6667
irc.anarchyplanet.org port 6697 (SSL) irc.anarchyplanet.org port 6697 (SSL)
km3jy7nrj3e2wiju.onion port 6667 || 6697 km3jy7nrj3e2wiju.onion port 6667 || 6697
```
*** using tor *** using tor
https://irc.anarchyplanet.org/pad/p/connect-to-apirc-with-tor https://irc.anarchyplanet.org/pad/p/connect-to-apirc-with-tor
** Basic Commands ** Basic Commands
@ -56,35 +57,35 @@
** Moderating Channels ** Moderating Channels
/kick nickname!userid@hostname ~/kick nickname!userid@hostname~
removes user from channel, but does not ban them. They are able to join immediately. removes user from channel, but does not ban them. They are able to join immediately.
/ban nickname!userid@hostname ~/ban nickname!userid@hostname~
bans user from channel, but does not kick them. They are prevented from speaking but can still see the channel. bans user from channel, but does not kick them. They are prevented from speaking but can still see the channel.
/kickban nickname!userid@hostname ~/kickban nickname!userid@hostname~
Use /whois, /whowas or /who to find the information necessary for a ban. Use ~/whois~, ~/whowas~ or ~/who~ to find the information necessary for a ban.
note: * is a wildcard and can replace nickname, userid, parts of nickname or userid, hostname or a segment of a hostname. note: ~*~ is a wildcard and can replace nickname, userid, parts of nickname or userid, hostname or a segment of a hostname.
/mode #channel +b nickname!userid@hostname ~/mode #channel +b nickname!userid@hostname~
the same as /ban the same as /ban
*** Ban Examples: *** Ban Examples:
joe!*@* ~joe!*@*~
Will prevent anyone with the nick joe from joining. Will prevent anyone with the nick joe from joining.
*myg0t*!* ~*myg0t*!*~
Will prevent anyone whose nick contains myg0t from joining. Will prevent anyone whose nick contains myg0t from joining.
mark!*elc@* ~mark!*elc@*~
Will prevent anyone with the nick mark and the userid elc from joining. Will prevent anyone with the nick mark and the userid elc from joining.
*!*@c-123-24-76-213.ga.isp.net ~*!*@c-123-24-76-213.ga.isp.net~
Will prevent anyone with the host c-123-24-76-213.ga.isp.net from joining. Will prevent anyone with the host c-123-24-76-213.ga.isp.net from joining.
*!*@* ~*!*@*~
Bans everyone. Don't do that. Bans everyone. Don't do that.
** Advanced Commands for the uberl337 ** Advanced Commands for the uberl337
@ -96,45 +97,60 @@ Bans everyone. Don't do that.
Setting people's modes (for current channel only). To set a user's mode outside of a channel, use ~/mode nickname #channel +/- attributes~ Setting people's modes (for current channel only). To set a user's mode outside of a channel, use ~/mode nickname #channel +/- attributes~
Some of the more important ones are: Some of the more important ones are:
~+q: User is owner of the current channel (prefix ~ or @)~ ~+q~ User is owner of the current channel (prefix ~ or @)
~+a: User is an admin (SOP) on the current channel (prefix & or @).~ ~+a~ User is an admin (SOP) on the current channel (prefix & or @).
~+o: User is an operator (AOP) on the current channel (prefix @).~ ~+o~ User is an operator (AOP) on the current channel (prefix @).
~+h: User is a half-op on the current channel (prefix %).~ ~+h~ User is a half-op on the current channel (prefix %).
~+v: User has voice on the current channel (prefix +).~ ~+v~ User has voice on the current channel (prefix +).
For a complete list of user modes visit https://wiki.inspircd.org/User_Modes For a complete list of user modes visit https://wiki.inspircd.org/User_Modes
*** Advanced Chanserv commands *** Advanced Chanserv commands
**** Commands
~/msg chanserv set #channel secure [on|off]~ Keeps everyone except aops, sops, and the founder from becoming ops.
~/msg chanserv set #channel keeptopic [on|off]~ Maintains the topic even if everyone leaves. ~/msg chanserv set #channel secure [on|off]~
Keeps everyone except aops, sops, and the founder from becoming ops.
~/msg chanserv set #channel enforce [on|off]~ Restores op/halfop/voice if a person with op/halfop/voice gets de-opped/halfopped/voiced. ~/msg chanserv set #channel keeptopic [on|off]~
Maintains the topic even if everyone leaves.
~/msg chanserv set #channel leaveops [on|off]~ Whether or not to allow the first person who join the channel to get ops. ~/msg chanserv set #channel enforce [on|off]~
Restores op/halfop/voice if a person with op/halfop/voice gets de-opped/halfopped/voiced.
~/msg chanserv drop #channel [dropcode]~ Un-registers the current channel to you with ChanServ. ~/msg chanserv set #channel leaveops [on|off]~
Whether or not to allow the first person who join the channel to get ops.
~/msg chanserv set #channel founder [nickname]~ Sets the current channel's founder. ~/msg chanserv drop #channel [dropcode]~
Un-registers the current channel to you with ChanServ.
~/msg chanserv set #channel desc [description]~ Changes the current channel's description. ~/msg chanserv set #channel founder [nickname]~
Sets the current channel's founder.
~/msg chanserv set #channel url [address]~ Associates a URL with the channel. ~/msg chanserv set #channel desc [description]~
Changes the current channel's description.
~/msg chanserv set #channel url [address]~
Associates a URL with the channel.
~/msg chanserv set #channel [email@address]~
Associates an email address with the channel.
~/msg chanserv set #channel [email@address]~ Associates an email address with the channel.
**** Channel modes **** Channel modes
~/mode #channel +/-attribute [data]~ ~/mode #channel +/-attribute [data]~
For a full list of Inspircd's channel modes visit https://wiki.inspircd.org/Channel_Modes For a full list of Inspircd's channel modes visit https://wiki.inspircd.org/Channel_Modes
*** Access lists *** Access lists
~/msg chanserv access #channel add [nickname] [level]~ ~/msg chanserv access #channel add [nickname] [level]~
Adds nickname to the channel's access list at the specified level. Adds nickname to the channel's access list at the specified level.
~/msg chanserv access channel del [nickname]~ ~/msg chanserv access channel del [nickname]~
Removes nickname from the channel's access list. Removes nickname from the channel's access list.
~/msg chanserv access #channel list~ ~/msg chanserv access #channel list~
Displays the channel's access list. Displays the channel's access list.
~/msg chanserv access #channel count~ ~/msg chanserv access #channel count~
Displays how many entries are in the channel's access list. Displays how many entries are in the channel's access list.
@ -168,30 +184,41 @@ Receive memos sent to the whole channel.
Can invite themselves to the channel. Can invite themselves to the channel.
*** SOPs *** SOPs
Can do everything AOPs can. - Can do everything AOPs can.
Can give and take AOP privileges. - Can give and take AOP privileges.
Receive memos sent to the channel's SOPs. - Receive memos sent to the channel's SOPs.
Can add (but not remove) AKICKs. - Can add (but not remove) AKICKs.
##Viewing and setting privileges
** Viewing and setting privileges
*** Viewing AOP and SOP lists *** Viewing AOP and SOP lists
/msg chanserv aop #channel list
/msg chanserv sop #channel list ~/msg chanserv aop #channel list~
adding a AOP or SOP
/msg chanserv [AOP|SOP] channel [ADD|DEL|LIST|CLEAR] [nick | entry-list] ~/msg chanserv sop #channel list~
Add an AOP or SOP
~/msg chanserv [AOP|SOP] channel [ADD|DEL|LIST|CLEAR] [nick | entry-list]~
*** AKICKs *** AKICKs
People on the AKICK list are automatically kicked and banned when they enter the channel. Bans made as a result of AKICK must be removed manually. People on the AKICK list are automatically kicked and banned when they enter the channel. Bans made as a result of AKICK must be removed manually.
/msg chanserv akick #channel add host [reason]
~/msg chanserv akick #channel add host [reason]~
Adds host to #channel's AKICK list [for reason]. Adds host to #channel's AKICK list [for reason].
/msg chanserv akick #channel del host
~/msg chanserv akick #channel del host~
Removes host from the AKICK list. Removes host from the AKICK list.
/msg chanserv akick #channel list
/msg chanserv akick #channel view ~/msg chanserv akick #channel list~
~/msg chanserv akick #channel view~
Displays the AKICK list. Displays the AKICK list.
*** Color codes *** Color codes
it's possible to color your text in irc. in most clients you can use control c then foreground,background (background is optional). examples: red text ^c4. black text on a blue background ^c1,2. here's a full list of the color codes:
It's possible to color your text in irc. in most clients you can use control c then foreground,background (background is optional). examples: red text ^c4. black text on a blue background ^c1,2. here's a full list of the color codes:
```
Number Name Number Name
00 white 00 white
01 black 01 black
@ -209,3 +236,4 @@ Number Name
13 pink (light purple / fuchsia) 13 pink (light purple / fuchsia)
14 grey 14 grey
15 light grey (silver) 15 light grey (silver)
```