diff --git a/ChangeLog b/ChangeLog index f80f522fd..2c8bfa982 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,11 @@ 2009-04-22 Badlop + * src/ejabberd.cfg.example: Fix English typos. Fix line length: + max 80 characters per line. Remove trailing blankspaces. Added + markers for Vim fold, you may want to add to $HOME/.vimrc this + line: set modeline + * src/ejabberdctl.cfg.example: Likewise + * src/mod_muc/mod_muc.erl: Limit number of characters in Room ID, Name and Description (EJAB-899) * src/mod_muc/mod_muc_room.erl: Likewise diff --git a/src/ejabberd.cfg.example b/src/ejabberd.cfg.example index 046db942b..9f8c34b24 100644 --- a/src/ejabberd.cfg.example +++ b/src/ejabberd.cfg.example @@ -1,10 +1,11 @@ %%% %%% ejabberd configuration file %%% +%%%' %%% The parameters used in this configuration file are explained in more detail %%% in the ejabberd Installation and Operation Guide. -%%% Please consult the Guide in case of doubts, it is included in +%%% Please consult the Guide in case of doubts, it is included in %%% your copy of ejabberd, and is also available online at %%% http://www.process-one.net/en/ejabberd/docs/ @@ -16,26 +17,26 @@ %%% - Each term ends in a dot, for example: %%% override_global. %%% -%%% - A tuple has a fixed definition, its elements are +%%% - A tuple has a fixed definition, its elements are %%% enclosed in {}, and separated with commas: %%% {loglevel, 4}. %%% -%%% - A list can have as many elements as you want, +%%% - A list can have as many elements as you want, %%% and is enclosed in [], for example: %%% [http_poll, web_admin, tls] %%% -%%% - A keyword of ejabberd is a word in lowercase. +%%% - A keyword of ejabberd is a word in lowercase. %%% The strings are enclosed in "" and can have spaces, dots... %%% {language, "en"}. -%%% {ldap_rootdn, "dc=example,dc=com"}. +%%% {ldap_rootdn, "dc=example,dc=com"}. %%% %%% - This term includes a tuple, a keyword, a list and two strings: %%% {hosts, ["jabber.example.net", "im.example.com"]}. %%% -%%% ======================= -%%% OVERRIDE STORED OPTIONS +%%%. ======================= +%%%' OVERRIDE STORED OPTIONS %% %% Override the old values stored in the database. @@ -57,8 +58,8 @@ %%override_acls. -%%% ========= -%%% DEBUGGING +%%%. ========= +%%%' DEBUGGING %% %% loglevel: Verbosity of log files generated by ejabberd. @@ -79,8 +80,8 @@ %%{watchdog_admins, ["bob@example.com"]}. -%%% ================ -%%% SERVED HOSTNAMES +%%%. ================ +%%%' SERVED HOSTNAMES %% %% hosts: Domains served by ejabberd. @@ -97,8 +98,8 @@ %%{route_subdomains, s2s}. -%%% =============== -%%% LISTENING PORTS +%%%. =============== +%%%' LISTENING PORTS %% %% listen: Which ports will ejabberd listen, which service handles it @@ -111,7 +112,7 @@ %% %% If TLS is compiled and you installed a SSL - %% certificate, put the correct path to the + %% certificate, put the correct path to the %% file and uncomment this line: %% %%{certfile, "/path/to/ssl.pem"}, starttls, @@ -140,7 +141,7 @@ %% ejabberd_service: Interact with external components (transports...) %% %%{8888, ejabberd_service, [ - %% {access, all}, + %% {access, all}, %% {shaper_rule, fast}, %% {ip, {127, 0, 0, 1}}, %% {hosts, ["icq.example.org", "sms.example.org"], @@ -149,7 +150,7 @@ %% ]}, {5280, ejabberd_http, [ - http_poll, + http_poll, web_admin ]} @@ -194,13 +195,14 @@ %% %%{outgoing_s2s_options, [ipv4, ipv6], 10000}. -%%% ============== -%%% AUTHENTICATION + +%%%. ============== +%%%' AUTHENTICATION %% %% auth_method: Method used to authenticate the users. %% The default method is the internal. -%% If you want to use a different method, +%% If you want to use a different method, %% comment this line and enable the correct ones. %% {auth_method, internal}. @@ -230,19 +232,19 @@ %%{auth_method, ldap}. %% %% List of LDAP servers: -%%{ldap_servers, ["localhost"]}. +%%{ldap_servers, ["localhost"]}. %% %% LDAP attribute that holds user ID: -%%{ldap_uids, [{"mail", "%u@mail.example.org"}]}. +%%{ldap_uids, [{"mail", "%u@mail.example.org"}]}. %% %% Search base of LDAP directory: -%%{ldap_base, "dc=example,dc=com"}. +%%{ldap_base, "dc=example,dc=com"}. %% %% LDAP manager: -%%{ldap_rootdn, "dc=example,dc=com"}. +%%{ldap_rootdn, "dc=example,dc=com"}. %% %% Password to LDAP manager: -%%{ldap_password, "******"}. +%%{ldap_password, "******"}. %% %% Anonymous login support: @@ -259,8 +261,8 @@ %%{host_config, "public.example.org", [{auth_method, [internal, anonymous]}]}. -%%% ============== -%%% DATABASE SETUP +%%%. ============== +%%%' DATABASE SETUP %% ejabberd uses by default the internal Mnesia database, %% so you can avoid this section. @@ -306,8 +308,8 @@ %%{odbc_keepalive_interval, undefined}. -%%% =============== -%%% TRAFFIC SHAPERS +%%%. =============== +%%%' TRAFFIC SHAPERS %% %% The "normal" shaper limits traffic speed to 1.000 B/s @@ -320,8 +322,8 @@ {shaper, fast, {maxrate, 50000}}. -%%% ==================== -%%% ACCESS CONTROL LISTS +%%%. ==================== +%%%' ACCESS CONTROL LISTS %% %% The 'admin' ACL grants administrative privileges to Jabber accounts. @@ -359,8 +361,8 @@ %%}. -%%% ============ -%%% ACCESS RULES +%%%. ============ +%%%' ACCESS RULES %% Maximum number of simultaneous sessions allowed for a single user: {access, max_user_sessions, [{10, all}]}. @@ -398,7 +400,7 @@ %% To disable in-band registration, replace 'allow' with 'deny'. {access, register, [{allow, all}]}. -%% By default frequency of account registrations from a the same IP +%% By default frequency of account registrations from the same IP %% is limited to 1 account every 10 minutes. To disable put: infinity %%{registration_timeout, 600}. @@ -413,8 +415,8 @@ %%}. -%%% ================ -%%% DEFAULT LANGUAGE +%%%. ================ +%%%' DEFAULT LANGUAGE %% %% language: Default language used for server messages. @@ -429,8 +431,8 @@ %%}. -%%% ======= -%%% MODULES +%%%. ======= +%%%' MODULES %% %% Modules enabled in all ejabberd virtual hosts. @@ -439,7 +441,7 @@ [ {mod_adhoc, []}, {mod_announce, [{access, announce}]}, % recommends mod_adhoc - {mod_caps, []}, + {mod_caps, []}, {mod_configure,[]}, % requires mod_adhoc {mod_disco, []}, %%{mod_echo, [{host, "echo.localhost"}]}, @@ -463,14 +465,14 @@ ]}, {mod_register, [ %% - %% After successful registration, the user receives + %% After successful registration, the user receives %% a message with this subject and body. %% - {welcome_message, {"Welcome!", + {welcome_message, {"Welcome!", "Hi.\nWelcome to this Jabber server."}}, %% - %% When a user registers, send a notification to + %% When a user registers, send a notification to %% these Jabber accounts. %% %%{registration_watchers, ["admin1@example.org"]}, @@ -498,9 +500,12 @@ %% ]}. +%%%. +%%%' + %%% $Id$ %%% Local Variables: %%% mode: erlang %%% End: -%%% vim: set filetype=erlang tabstop=8: +%%% vim: set filetype=erlang tabstop=8 foldmarker=%%%',%%%. foldmethod=marker: diff --git a/src/ejabberdctl.cfg.example b/src/ejabberdctl.cfg.example index 661d8ce77..d6bb80e16 100644 --- a/src/ejabberdctl.cfg.example +++ b/src/ejabberdctl.cfg.example @@ -1,21 +1,22 @@ # -# In this file you can configure options that are passed by ejabberdctl +# In this file you can configure options that are passed by ejabberdctl # to the erlang runtime system when starting ejabberd # -# POLL: Kernel polling ([true|false]) +#' POLL: Kernel polling ([true|false]) # # The kernel polling option requires support in the kernel. -# Additionaly, you need to enable this feature while compiling Erlang. +# Additionally, you need to enable this feature while compiling Erlang. # # Default: true # #POLL=true -# SMP: SMP support ([enable|auto|disable]) +#. +#' SMP: SMP support ([enable|auto|disable]) # # Explanation in Erlang/OTP documentation: -# enable: starts the Erlang runtime system with SMP support enabled. +# enable: starts the Erlang runtime system with SMP support enabled. # This may fail if no runtime system with SMP support is available. # auto: starts the Erlang runtime system with SMP support enabled if it # is available and more than one logical processor are detected. @@ -25,9 +26,10 @@ # #SMP=auto -# ERL_MAX_PORTS: Maximum number of simultaneously open Erlang ports +#. +#' ERL_MAX_PORTS: Maximum number of simultaneously open Erlang ports # -# ejabberd consumes two or three ports for every connection, either +# ejabberd consumes two or three ports for every connection, either # from a client or from another Jabber server. So take this into # account when setting this limit. # @@ -36,21 +38,23 @@ # #ERL_MAX_PORTS=32000 -# FIREWALL_WINDOW: Range of allowed ports to pass through a firewall +#. +#' FIREWALL_WINDOW: Range of allowed ports to pass through a firewall # # If Ejabberd is configured to run in cluster, and a firewall is blocking ports, -# it's possible to make Erlang use a defined range of port (instead of dynamic ports) -# for node communication. +# it's possible to make Erlang use a defined range of port (instead of dynamic +# ports) for node communication. # # Default: not defined # Example: 4200-4210 # #FIREWALL_WINDOW= -# PROCESSES: Maximum number of Erlang processes +#. +#' PROCESSES: Maximum number of Erlang processes # # Erlang consumes a lot of lightweight processes. If there is a lot of activity -# on ejabberd so that the maximum number of proccesses is reached, people will +# on ejabberd so that the maximum number of processes is reached, people will # experiment greater latency times. As these processes are implemented in # Erlang, and therefore not related to the operating system processes, you do # not have to worry about allowing a huge number of them. @@ -60,7 +64,8 @@ # #PROCESSES=250000 -# ERL_MAX_ETS_TABLES: Maximum number of ETS and Mnesia tables +#. +#' ERL_MAX_ETS_TABLES: Maximum number of ETS and Mnesia tables # # The number of concurrent ETS and Mnesia tables is limited. When the limit is # reached, errors will appear in the logs: @@ -72,6 +77,8 @@ # #ERL_MAX_ETS_TABLES=1400 +#. +#' ERLANG_NODE # The next variable allows to explicitly specify erlang node for ejabberd # It can be given in different formats: # ERLANG_NODE=ejabberd @@ -80,9 +87,11 @@ # Erlang uses node name as is (so make sure that hostname is a real # machine hostname or you'll not be able to control ejabberd) # ERLANG_NODE=ejabberd@hostname.domainname -# The same as previous, but erlang will use long hostname +# The same as previous, but erlang will use long hostname # (see erl (1) manual for details) # # Default: ejabberd # #ERLANG_NODE=ejabberd + +# vim: foldmarker=#',#. foldmethod=marker: