* src/ejabberdctl.template: Removed bashisms (EJAB-399). Set environment variables instead of passing parameters when calling erl (EJAB-421).

* src/ejabberd_ctl.erl: Improvements in the help messages (EJAB-399).

* doc/guide.tex: Improvements in sections ejabberdctl, and Install from Source (EJAB-399).

SVN Revision: 978

2 files changed, 41 insertions, 19 deletions

diff --git a/src/ejabberd_ctl.erl b/src/ejabberd_ctl.erl
index 6ccfe36ef..a6c972303 100644
--- a/src/ejabberd_ctl.erl
+++ b/src/ejabberd_ctl.erl
@@ -24,7 +24,21 @@
 start() ->
     case init:get_plain_arguments() of
 	[SNode | Args] ->
-	    Node = list_to_atom(SNode),
+	    SNode1 = case string:tokens(SNode, "@") of
+		[_Node, _Server] ->
+		    SNode;
+		_ ->
+		    case net_kernel:longnames() of
+			 true ->
+			     SNode ++ "@" ++ inet_db:gethostname() ++
+				      "." ++ inet_db:res_option(domain);
+			 false ->
+			     SNode ++ "@" ++ inet_db:gethostname();
+			 _ ->
+			     SNode
+		     end
+	    end,
+	    Node = list_to_atom(SNode1),
 	    Status = case rpc:call(Node, ?MODULE, process, [Args]) of
 			 {badrpc, Reason} ->
 			     io:format("RPC failed on the node ~p: ~p~n",
@@ -248,13 +262,15 @@ print_usage() ->
 		   Desc, NewLine]
 	  end, CmdDescs),
     io:format(
-      "Usage: ejabberdctl node command~n"
+      "Usage: ejabberdctl [--node nodename] command [options]~n"
       "~n"
-      "Available commands:~n"
+      "Available commands in this ejabberd node:~n"
       ++ FmtCmdDescs ++
       "~n"
-      "Example:~n"
-      "  ejabberdctl ejabberd@host restart~n"
+      "Examples:~n"
+      "  ejabberdctl restart~n"
+      "  ejabberdctl --node ejabberd@host restart~n"
+      "  ejabberdctl vhost jabber.example.org ...~n"
      ).
 
 print_vhost_usage(Host) ->
@@ -279,11 +295,13 @@ print_vhost_usage(Host) ->
 		   Desc, NewLine]
 	  end, CmdDescs),
     io:format(
-      "Usage: ejabberdctl node vhost host command~n"
+      "Usage: ejabberdctl [--node nodename] vhost hostname command [options]~n"
       "~n"
-      "Available commands:~n"
+      "Available commands in this ejabberd node and this vhost:~n"
       ++ FmtCmdDescs ++
       "~n"
+      "Examples:~n"
+      "  ejabberdctl vhost "++Host++" registered-users~n"
      ).
 
 register_commands(CmdDescs, Module, Function) ->
diff --git a/src/ejabberdctl.template b/src/ejabberdctl.template
index 106852fcf..cbc41900e 100644
--- a/src/ejabberdctl.template
+++ b/src/ejabberdctl.template
@@ -6,7 +6,8 @@ ERLANG_NODE=$NODE@$HOST
 
 # Define ejabberd environment
 ROOTDIR=@rootdir@
-EJABBERD_CFG=$ROOTDIR/etc/ejabberd/ejabberd.cfg
+EJABBERD_CONFIG_PATH=$ROOTDIR/etc/ejabberd/ejabberd.cfg
+export EJABBERD_CONFIG_PATH
 EJABBERDCTL_CFG=$ROOTDIR/etc/ejabberd/ejabberdctl.cfg
 EJABBERD_INETRC=$ROOTDIR/etc/ejabberd/ejabberd.inetrc
 EJABBERD_EBIN=$ROOTDIR/var/lib/ejabberd/ebin
@@ -14,6 +15,7 @@ EJABBERD_DB=$ROOTDIR/var/lib/ejabberd/db/$NODE
 EJABBERD_MSGS_PATH=$ROOTDIR/var/lib/ejabberd/priv/msgs
 EJABBERD_SO_PATH=$ROOTDIR/var/lib/ejabberd/priv/lib
 EJABBERD_LOG_PATH=$ROOTDIR/var/log/ejabberd/ejabberd.log
+export EJABBERD_LOG_PATH
 SASL_LOG_PATH=$ROOTDIR/var/log/ejabberd/sasl.log
 
 [ -d $EJABBERD_DB ] || mkdir -p $EJABBERD_DB
@@ -35,9 +37,12 @@ else
     SNAME=-name
 fi
 
+# Compatibility in ZSH
+#setopt shwordsplit 2>/dev/null
+
 ERLANG_OPTS="$POLL $PROCESSES $ERL_MAX_ETS_TABLES"
 
-function start
+start ()
 {
     erl \
       $SNAME $ERLANG_NODE \
@@ -46,12 +51,10 @@ function start
       -pa $EJABBERD_EBIN \
       -mnesia dir "\"$EJABBERD_DB\"" \
       -s ejabberd \
-      -ejabberd config \"$EJABBERD_CFG\" \
-                log_path \"$EJABBERD_LOG_PATH\" \
       -sasl sasl_error_logger \{file,\"$SASL_LOG_PATH\"\}
 }
 
-function debug
+debug ()
 {
     echo "--------------------------------------------------------------------"
     echo ""
@@ -66,14 +69,15 @@ function debug
     echo "  control+c, control+c"
     echo ""
     echo "--------------------------------------------------------------------"
-    read -p "Press any key to continue"
+    echo "Press any key to continue"
+    read foo
     echo ""
     erl \
       $SNAME debug \
       -remsh $ERLANG_NODE
 }
 
-function live
+live ()
 {
     echo "--------------------------------------------------------------------"
     echo ""
@@ -87,18 +91,18 @@ function live
     echo "  q().  and press the Enter key"
     echo ""
     echo "--------------------------------------------------------------------"
-    read -p "Press any key to continue"
+    echo "Press any key to continue"
+    read foo
     echo ""
     erl \
       $SNAME $ERLANG_NODE \
       $ERLANG_OPTS \
       -pa $EJABBERD_EBIN \
       -mnesia dir "\"$EJABBERD_DB\"" \
-      -ejabberd config \"$EJABBERD_CFG\" \
       -s ejabberd
 }
 
-function ctl
+ctl ()
 {
     erl \
       $SNAME ejabberdctl \
@@ -111,13 +115,13 @@ function ctl
     esac
 }
 
-function usage
+usage ()
 {
     ctl
     exit
 }
 
-function help_start
+help_start ()
 {
     echo ""
     echo "Commands to start an ejabberd node:"