summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBadlop <badlop@process-one.net>2015-01-28 17:16:10 +0100
committerBadlop <badlop@process-one.net>2015-01-28 17:16:10 +0100
commit87d2eb5f9a6a3524da391442138316af358d9822 (patch)
treeea618bf8d5f2361c779d3f819f0cb2eb948e01ef /doc
parentMerge pull request #414 from weiss/fix-function-specs (diff)
Support for "> ." in YAML configuration files
Diffstat (limited to 'doc')
-rw-r--r--doc/guide.tex23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/guide.tex b/doc/guide.tex
index b21e3a03..62e7fc8e 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -693,6 +693,29 @@ in Erlang terms. The format is still supported, but it is highly recommended
to convert it to the new YAML format using \term{convert\_to\_yaml} command
from \term{ejabberdctl} (see~\ref{ejabberdctl} and \ref{list-eja-commands} for details).
+If you want to specify some options using the old Erlang format,
+you can set them in an additional cfg file, and include it using
+the \option{include\_config\_file} option, see \ref{includeconfigfile}
+for the option description and a related example in \ref{accesscommands}.
+
+If you just want to provide an erlang term inside an option,
+you can use the \term{"> erlangterm."} syntax for embedding erlang terms in a YAML file, for example:
+\begin{verbatim}
+modules:
+ mod_cron:
+ tasks:
+ - time: 10
+ units: seconds
+ module: mnesia
+ function: info
+ arguments: "> []."
+ - time: 3
+ units: seconds
+ module: ejabberd_auth
+ function: try_register
+ arguments: "> [\"user1\", \"localhost\", \"pass\"]."
+\end{verbatim}
+
\makesubsection{hostnames}{Host Names}
\ind{options!hosts}\ind{host names}