AMULEWEB(1)

NAME
imuleweb - iMule web server

SYNOPSIS
imuleweb [-h <host>] [-p <port>] [-P <pass>] [-f <path>] [-l <lang>] [-q] [-v] [-w] [-t <name>] [-s <port>] [-z] [-Z] [-A <pass>] [-G <pass>] [-a] [-d] [-L]

imuleweb [-f <path>] --create-config-from=<path>

imuleweb [--help] [--version]

imuleweb --imule-config-file=<path>

DESCRIPTION
imuleweb manages your access to imule through a webbrowser. You can start imuleweb together with imule(1), or separately, any time later. Options can be specified via command-line or via config-file. Command-line options take precedence over config-file options.

-h, --host=<host>
    Host where iMule is running (default: localhost). <host> might be an IP address or a DNS name

-p, --port=<port>
    iMule's port for External Connections, as set in Preferences->Remote Controls (default: 4712)

-P, --password=<passwd>
    External Connections password

-f, --config-file=<path>
    Use the given configuration file. Default configuration file is ~/.iMule/remote.conf

-l, --locale=<lang>
    Sets program locale (language). See section NOTES for the description of the <lang> parameter.

-q, --quiet
    Do not print any output to stdout. You may want to use -q to daemonize the webserver, i.e. running as 'imuleweb -q &'

-v, --verbose
    Be verbose - show also debug messages

-w, --write-config
    Write command line options to config file and exit

--create-config-from=<path>
    Create config file based upon <path>, which must point to a valid iMule config file, and then exit

-t, --template=<name>
    Loads the template named <name>. See also the section SKIN SUPPORT

-s, --server-port=<port>
    Webserver's HTTP port. This is the port you can point your browser to (default: 4711)

-z, --enable-gzip
    Enable using gzip compression in HTTP traffic to save bandwidth

-Z, --disable-gzip
    Disable using gzip compression (this is the default)

-A, --admin-pass=<passwd>
    Full access password for webserver

-G, --guest-pass=<passwd>
    Guest password for webserver

-a, --allow-guest
    Allow guest access

-d, --deny-guest
    Deny guest access (default)

-L, --load-settings
    Load/save webserver settings from/to remote iMule. This causes imuleweb to ignore command-line and config-file settings, and load them from iMule. When saving preferences none will be written to the config file, but to iMule. (Of course, this works only for those settings, that can be set in iMule's Preferences->Remote Controls)

--imule-config-file=<path>
    iMule config file path. DO NOT USE DIRECTLY! iMule uses this option when starting imuleweb at iMule startup. This option causes all other command-line and config-file settings to be ignored, preferences to be read from the given config file, and also implies the -q -L options.

--help
    Display usage help information and exit

--version
    Output program version information and exit

NOTES

  Paths
If you specify a file without giving an absolute path (i.e. just a plain filename, such as --path=remote.conf), then this file is searched within the iMule configuration directory, ~/.iMule.

  Languages
The <lang> parameter for the -l option has the following form: lang[_LANG][.encoding][@modifier] where lang is the primary language, LANG is a sublanguage/territory, encoding is the character set to use and modifier "allows the user to select a specific instance of localization data within a single category".

For example, the following strings are valid:
fr
fr_FR
de_DE.iso88591
de_DE@euro
de_DE.iso88591@euro

Though all the above strings are accepted as valid language definitions, encoding and modifier are yet unused.

In addition to the format above, you can also specify full language names in English - so -l german is also valid and is equal to -l de_DE.

When no locale is defined, either on command-line or in config file, system default language will be used.

SKIN SUPPORT
imuleweb is capable of displaying information in different skins. These skins are called templates, and you can make imuleweb load a specific template via the -t command line option. Templates are searched in two places: first in ~/.iMule/webserver/ and then in $(pkgdatadir)/webserver/ ($(pkgdatadir) is the install location of architecture independent data, most likely something like /usr/share/imule). Each template must be in a subdirectory of the template name, and this directory must contain all files the template needs. The actual template filename must be iMule.tmpl.

For example, the default template (named 'default') is in webserver/default/, and this directory contains iMule.tmpl amongst a lot of image files.

FILES
~/.iMule/remote.conf
~/.iMule/webserver/
$(pkgdatadir)/webserver/

EXAMPLE
Typically imuleweb will be first run as:

imuleweb -h hostname -p ECport -P ECpassword -s HTTPport -A AdminPassword -w

or

imuleweb --create-config-from=/home/username/.iMule/imule.conf

These will save settings to $HOME/.iMule/remote.conf, and later you only need to type:

imuleweb

Of course, you may specify any more or less options on the first example line, and you may also totally omit it.

REPORTING BUGS
Please report bugs either on our forum (http://forum.imule.org/), or in our bugtracker (http://bugs.imule.org/). Please do not report bugs in e-mail, neither to our mailing list nor directly to any team member.

COPYRIGHT
iMule and all of its related utilities are distributed under the GNU General Public License.

SEE ALSO
imule(1), imulecmd(1)