diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CMakeLists.txt | 4 | ||||
| -rw-r--r-- | docs/Changes.conf | 6 | ||||
| -rw-r--r-- | docs/EVENTS | 7 | ||||
| -rw-r--r-- | docs/INSTALL | 18 | ||||
| -rw-r--r-- | docs/INSTALL.fr | 22 | ||||
| -rw-r--r-- | docs/LANGUAGE | 2 | ||||
| -rw-r--r-- | docs/MODULES | 4 | ||||
| -rw-r--r-- | docs/README | 6 | ||||
| -rw-r--r-- | docs/TOOLS | 4 | ||||
| -rw-r--r-- | docs/WIN32.txt | 4 |
10 files changed, 40 insertions, 37 deletions
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 082b1da0e..fd93e81c0 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -6,10 +6,10 @@ if(WIN32) if(IN_SOURCE) # Add README.txt to list of files for CPack to ignore add_to_cpack_ignored_files("README.txt$" TRUE) - endif(IN_SOURCE) + endif() set(DOCS Changes Changes.conf DEFCON FAQ INSTALL LANGUAGE MODULES NEWS ${CMAKE_CURRENT_BINARY_DIR}/README.txt WIN32.txt) install(FILES ${DOCS} DESTINATION ${DOC_DIR} ) set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_BINARY_DIR}/README.txt") -endif(WIN32) +endif() diff --git a/docs/Changes.conf b/docs/Changes.conf index c2858d69e..68349691f 100644 --- a/docs/Changes.conf +++ b/docs/Changes.conf @@ -1,3 +1,9 @@ +Anope Version 2.1.0-git +-------------------- +Added nickserv:minpasslen for configuring the minimum password length. +Removed nickserv:strictpasswords as it is obsolete now nickserv:minpasslen exists. +Renamed nickserv:passlen to nickserv:maxpasslen. + Anope Version 2.0.10 -------------------- No significant changes. diff --git a/docs/EVENTS b/docs/EVENTS index 54e9c87a5..ba570289b 100644 --- a/docs/EVENTS +++ b/docs/EVENTS @@ -22,13 +22,10 @@ Anope Internal Events The full list of functions and parameters are in modules.h. In this case, you would be overriding OnJoinChannel() and OnPartChannel() like so: - void OnJoinChannel(User *u, Channel *c) anope_override { } - void OnPartChannel(User *u, Channel *c) anope_override { } + void OnJoinChannel(User *u, Channel *c) override { } + void OnPartChannel(User *u, Channel *c) override { } Some of these event overrides can be used to prevent or allow things to happen that would normally not be allowed or denied. You can also use ModuleManager (not explained here) to set control which order the modules are queried (when multiple modules hook to the same event). - - The "anope_override" identifier is for compatibility with C++11. - Its usage is highly recommended. diff --git a/docs/INSTALL b/docs/INSTALL index 1ad9533cb..ffbf04906 100644 --- a/docs/INSTALL +++ b/docs/INSTALL @@ -52,8 +52,8 @@ Note: You should also read the README and FAQ files! cause trouble on your network if passwords are not encrypted, or read the memos of any user. - Now go into the conf directory (by default, ~/services/conf). Copy the example - configuration file (example.conf) to services.conf, and open the latter + Now go into the conf directory (by default, ~/anope/conf). Copy the example + configuration file (anope.example.conf) to anope.conf, and open the latter with your favorite text editor. It contains all the configuration directives Anope will use at startup. Read the instructions contained in the file carefully. Using the default values is NOT a good idea, and will @@ -71,7 +71,7 @@ Note: You should also read the README and FAQ files! * IMPORTANT: Back up your old databases! * If you are upgrading to a new major release, ALWAYS restart a - fresh configuration file from example.conf. + fresh configuration file from anope.example.conf. 3) Setting up the IRCd @@ -83,7 +83,7 @@ Note: You should also read the README and FAQ files! a shared block), and be sure that the IRCd is listening on the given port in the link block. - Example link configurations can be found in example.conf for some of the + Example link configurations can be found in anope.example.conf for some of the popular IRCds. Don't forget to /rehash your IRCd to apply changes. @@ -95,7 +95,7 @@ Note: You should also read the README and FAQ files! 4) Starting Anope Go into the directory where binaries were installed (by default, this is - ~/services/bin). Type ./services to launch Anope. + ~/anope/bin). Type ./anope to launch Anope. If there are syntax errors in the configuration file they will be displayed on the screen. Correct them until there are no errors anymore. @@ -104,7 +104,7 @@ Note: You should also read the README and FAQ files! Give Services at least one minute to link to your network, as certain IRCds on some OSes may be really slow for the link process. If nothing happens after about a minute, it is probably a configuration problem. Try - to launch Anope with ./services -debug -nofork to see any errors that it + to launch Anope with ./anope -debug -nofork to see any errors that it encounters, and try to correct them. If you need help to solve errors, feel free to subscribe to the Anope @@ -116,16 +116,16 @@ Note: You should also read the README and FAQ files! still running, and restart it if not. First rename the example.chk script that is in Anope path (by default, - this is ~/services/conf) to services.chk and edit it. You'll need to + this is ~/anope/conf) to anope.chk and edit it. You'll need to modify the CONFIGURATION part of the file. Then ensure that the file is - marked as executable by typing chmod +x services.chk, and try to launch the + marked as executable by typing chmod +x anope.chk, and try to launch the script to see if it works (Anope must not be running when you do this ;)) When this is done, you'll have to add the crontab entry. Type crontab -e. This will open the default text editor with the crontab file. Enter the following (with correct path): - */5 * * * * /home/ircd/services/conf/services.chk >/dev/null 2>&1 + */5 * * * * /home/ircd/anope/conf/anope.chk >/dev/null 2>&1 The */5 at the beginning means "check every 5 minutes". You may replace the 5 with other another number if you want (but less than 60). Consult diff --git a/docs/INSTALL.fr b/docs/INSTALL.fr index 245af3e57..c674f3f3d 100644 --- a/docs/INSTALL.fr +++ b/docs/INSTALL.fr @@ -49,15 +49,15 @@ Note : Vous devrez également lire les fichiers README et FAQ ! Allez dans le dossier build (cd build) et tapez make et make install. Ceci va installer tous les fichiers nécessaires dans les dossiers que vous avez indiqués avec le script Config et régler les permissions des - fichiers. Vous devez vous assurer que le répertoire data n'est pas + fichiers. Vous devez vous assurer que le répertoire data n'est pas accessible par les autres utilisateurs, car des utilisateurs malveillants pourraient causer des problèmes sur votre réseau, si les mots de passe ne sont pas chiffrés, ou lire les mémos de tous les utilisateurs. - Allez maintenant dans le répertoire conf (par défaut, ~/services/conf). - Copiez l'exemple de fichier de configuration (example.conf) en - services.conf et ouvrez ce dernier avec votre éditeur de texte favori. + Allez maintenant dans le répertoire conf (par défaut, ~/anope/conf). + Copiez l'exemple de fichier de configuration (anope.example.conf) en + anope.conf et ouvrez ce dernier avec votre éditeur de texte favori. Il contient toutes les directives de configuration qu'Anope va utiliser en démarrant. Lisez attentivement les instructions contenues dans le fichier. L'utilisation des valeurs par défaut n'est pas toujours @@ -78,7 +78,7 @@ Note : Vous devrez également lire les fichiers README et FAQ ! * IMPORTANT : Sauvegardez vos anciennes bases de données ! * Si vous mettez à jour vers une nouvelle version majeure, recommencez *toujours* toute votre configuration à partir du - fichier example.conf. + fichier anope.example.conf. 3) Configuration de l'IRCd @@ -92,7 +92,7 @@ Note : Vous devrez également lire les fichiers README et FAQ ! sur le port donné dans le bloc link. Des exemples de configurations de bloc link peuvent être trouvés dans - le fichier example.conf pour certains des IRCd les plus populaires. + le fichier anope.example.conf pour certains des IRCd les plus populaires. Souvenez-vous de /rehash votre IRCd pour appliquer les changements. @@ -104,7 +104,7 @@ Note : Vous devrez également lire les fichiers README et FAQ ! 4) Mettre en route Anope Allez dans le répertoire où les fichiers binaires ont été installés - (par défaut, ~/services/bin). Tapez ./services pour lancer Anope. + (par défaut, ~/anope/bin). Tapez ./anope pour lancer Anope. S'il y a des erreurs de syntaxe dans le fichier de configuration, elles seront affichées à l'écran. Corrigez-les jusqu'à ce qu'il n'y en ait @@ -114,7 +114,7 @@ Note : Vous devrez également lire les fichiers README et FAQ ! réseau, car certains IRCds sur certains systèmes peuvent être très lents pour le processus de liaison. Si rien ne se passe après environ une minute, il y a probablement un problème de configuration. Essayez - de lancer Anope en mode debug avec ./services -debug -nofork pour voir + de lancer Anope en mode debug avec ./anope -debug -nofork pour voir toutes les erreurs rencontrées et essayez de les corriger. Si vous avez besoin d'aide pour résoudre des erreurs, n'hésitez pas à @@ -127,10 +127,10 @@ Note : Vous devrez également lire les fichiers README et FAQ ! est toujours en cours d'exécution et de le redémarrer s'il n'est pas. D'abord renommez le script example.chk qui est dans les dossiers - d'Anope (par défaut, ~/services/conf) en services.chk et modifiez-le. + d'Anope (par défaut, ~/anope/conf) en anope.chk et modifiez-le. Vous aurez besoin de modifier la partie CONFIGURATION du fichier. Assurez-vous ensuite que le fichier est marqué comme exécutable en - tapant chmod +x services.chk et essayez de lancer le script pour voir + tapant chmod +x anope.chk et essayez de lancer le script pour voir si cela fonctionne (Anope ne doit pas être en marche lorsque vous testez cela ;)) @@ -138,7 +138,7 @@ Note : Vous devrez également lire les fichiers README et FAQ ! crontab -e. Cela va ouvrir l'éditeur de texte par défaut avec le fichier crontab. Entrez la ligne suivante (avec le chemin correct) : - */5 * * * * /home/ircd/services/conf/services.chk > /dev/null 2>&1 + */5 * * * * /home/ircd/anope/conf/anope.chk > /dev/null 2>&1 Le */5 au début signifie "vérifier toutes les 5 minutes". Vous pouvez remplacer le 5 par un autre numéro si vous voulez (mais moins de 60). diff --git a/docs/LANGUAGE b/docs/LANGUAGE index b2e72cc9a..3aab36b45 100644 --- a/docs/LANGUAGE +++ b/docs/LANGUAGE @@ -25,7 +25,7 @@ Anope Multi Language Support Anope uses gettext (https://www.gnu.org/software/gettext/) to translate messages for users. To add a new language install gettext and run `msginit -l language -o anope.language.po -i anope.pot`. For example if I was translating to Spanish I could run `msginit -l es_ES -o anope.es_ES.po -i anope.pot`. Open the newly generating .po file and start - translating. Once you are done simply rerun ./Config; make && make install and add the language to your services.conf. + translating. Once you are done simply rerun ./Config; make && make install and add the language to your anope.conf. Note that on Windows it is not quite this simple, windows.cpp must be edited and Anope recompiled and restarted. Poedit (https://poedit.net/) is a popular po file editor, and we recommend using it or another editor designed to edit diff --git a/docs/MODULES b/docs/MODULES index 52cb3b25c..d74f4f35a 100644 --- a/docs/MODULES +++ b/docs/MODULES @@ -22,7 +22,7 @@ Anope Modules 1. If modules are supported by your system, they will be configured automatically when you run ./Config. The modules will be installed to the modules directory in your data path (by default this will - be ~/services/data/modules). + be ~/anope/data/modules). 2. Compile Anope as usual using ./Config. The "make" process will now compile module support into Anope, and compile the default sample @@ -98,7 +98,7 @@ Anope Modules 1. Make sure you're in the main source directory. (usually anope-1.X.XX/) 2. Run ./Config to find and configure modules, then `cd build`. 3. Run `make` to compile Anope, and any modules. - 4. Run `make install` to copy the compiled binaries to the ~/services/ + 4. Run `make install` to copy the compiled binaries to the ~/anope/ directory. You can now use /msg OperServ MODLOAD to load the new modules. diff --git a/docs/README b/docs/README index f4a912b07..bdadb6823 100644 --- a/docs/README +++ b/docs/README @@ -167,13 +167,13 @@ Table of Contents Anope currently works with: * Bahamut 1.4.27 or later (including 1.8) - * Charybdis 3.4 or later * ircd-hybrid 8.2.23 or later - * InspIRCd 1.2 or later + * InspIRCd 3 or later * ngIRCd 19.2 or later * Plexus 3 or later * Ratbox 2.0.6 or later - * UnrealIRCd 3.2 or later + * Solanum (all versions) + * UnrealIRCd 4 or later Anope could also work with some of the daemons derived by the ones listed above, but there's no support for them if they work or don't work. diff --git a/docs/TOOLS b/docs/TOOLS index 5e8f139cb..8b036065f 100644 --- a/docs/TOOLS +++ b/docs/TOOLS @@ -8,12 +8,12 @@ Anope Bundled Tools The SMTP client can be used instead of sendmail for use with Anope's mail options. To use the SMTP client instead of sendmail, find the line in your - services configuration file (services.conf) that defines sendmailpath. On + services configuration file (anope.conf) that defines sendmailpath. On that line, change the path to your services installation directory, then followed by "bin/anopesmtp" and the IP address of a valid SMTP server. It should look like this: - sendmailpath = "/home/anope/services/bin/anopesmtp 127.0.0.1" + sendmailpath = "/home/ircd/anope/bin/anopesmtp 127.0.0.1" If the SMTP client doesn't send mail, or if there's an other problem with it, you can enable debug mode by passing the --debug flag after the server diff --git a/docs/WIN32.txt b/docs/WIN32.txt index 2880cb0e0..104ef7441 100644 --- a/docs/WIN32.txt +++ b/docs/WIN32.txt @@ -103,7 +103,7 @@ Anope for Windows INSTALL within the Solution Explorer. Right-click on INSTALL and choose Build.
When you have done this, all the files will be installed to where they belong.
- The only thing you need to do is rename "data/example.conf" to be "data/services.conf",
+ The only thing you need to do is rename "data/anope.example.conf" to be "data/anope.conf",
and then follow the steps to set up Anope.
You have now completed the building phase of Anope for Windows. You can
@@ -120,7 +120,7 @@ Anope for Windows Notepad will cause strange characters to appear, and you may not be able to
edit the file correctly.
- Open services.conf, and read through it carefully and adjust the settings
+ Open anope.conf, and read through it carefully and adjust the settings
you think you need to adjust.
If you are unsure of the settings, you can go to the dos command prompt
|