ZIM

On Unix environments, the Zim executable is the only available tool to run or develop Zim applications.

 

zim -n database [-u user] [-p password] [-c command] [-o port] [-h host name] [-w work path]

Parameters

-n database is one of the database names provided in the zimdb.zim configuration file when Zim Server was started. This parameter is obligatory
-p password is the password for this user as known by Zim. The users ZIM and super don't have a password; just provide the parameter as -p "". It omitted, it is assumed the null string ("")
-u user is a user name known by Zim. Usually, any Zim database contains, by default, the users ZIM and super.  It omitted, this parameter is assumed "ZIM"
-c command is the Zim command you want to execute when Zim starts.  It omitted, it is assumed "zimprof"
-o port is the server port number used to connect to Zim Server as specified in zimconfig.srv configuration file.  It omitted, this port is "6002"
-h host name is the name the machine where Zim Server is running. It can be a name or an IP address known to the network.  It omitted, it is assumed "localhost"
-w work path is an operating system absolute address where temporary files used by this Zim session will be place. It omitted, it is assumed the null string ("")

Comments

When Zim starts, it connects to ZimServer using the database name specified, takes the appropriates parameters from the database configuration file and then either executes immediately the Zim command specified in the parameters or prompts the user.

 

If one or more parameters are missing then Zim, will prompt the user to provide the correct information, as shown in this example:

Note: The parameter "-w" is provided to allow administrators to determine exactly which directory of the operating system should be used as the work path for the current Zim session.

 

Note: On Windows, only the ZIMQTC executable should be used to develop and deploy applications.