Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
AMULEWEB(1)			aMule utilities			   AMULEWEB(1)

NAME
       amuleweb	- aMule	web server

SYNOPSIS
       amuleweb	 [-h _host_] [-p _port_] [-P _password_] [-f _path_] [-q] [-v]
       [-l _lang_] [-w]	[-t _name_] [-s	_port_]	[-u] [-U _port_] [-z] [-Z] [-A
       _password_] [-G _password_] [-a | -d] [-L] [--no-php] [-N]

       amuleweb	[--create-config-from=_path_]

       amuleweb	[--help]

       amuleweb	[--version]

       amuleweb	[--amule-config-file=_path_]

DESCRIPTION
       amuleweb	 manages  your access to amule through a web browser.  You can
       start amuleweb together with amule(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_ ]
	      Host where aMule is running (default: localhost).	 _host_	 might
	      be an IP address or a DNS	name

       [ -p _port_, --port=_port_ ]
	      aMule's  port  for  External  Connections,  as  set  in  Prefer-
	      ences->Remote Controls (default: 4712)

       [ -P _password_,	--password=_password_ ]
	      External Connections password.

       [ -f _path_, --config-file=_path_ ]
	      Use the given configuration file.	 Default configuration file is
	      ~/.aMule/remote.conf

       [ -q, --quiet ]
	      Do not print any output to stdout.

       [ -v, --verbose ]
	      Be verbose - show	also debug messages.

       [ -l _lang_, --locale=_lang_ ]
	      Sets  program  locale (language).	 See the NOTES section for the
	      description of the _lang_	parameter.

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

       [ -t _name_, --template=_name_ ]
	      Loads the	template named _name_. See the	SKIN  SUPPORT  section
	      for details.

       [ -s _port_, --server-port=_port_ ]
	      Webserver's  HTTP	 port.	This  is  the port you must point your
	      browser to (default: 4711).

       [ -u ]
	      Enable UPnP.

       [ -U _port_, --upnp-port	_port_ ]
	      UPnP port.

       [ -z, --enable-gzip ]
	      Enables using gzip compression in	HTTP  traffic  to  save	 band-
	      width.

       [ -Z, --disable-gzip ]
	      Disables using gzip compression (this is the default).

       [ -A _passwd_, --admin-pass=_passwd_ ]
	      Full access password for webserver.

       [ -G _passwd_, --guest-pass=_passwd_ ]
	      Guest password for webserver.

       [ -a, --allow-guest ]
	      Allows guest access.

       [ -d, --deny-guest ]
	      Denies guest access (default).

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

       [ --no-php ]
	      Disable PHP interpreter (deprecated)

       [ -N, --no-script-cache ]
	      Recompiles PHP pages on each request.

       [ --create-config-from=_path_ ]
	      Create config file based upon _path_,  which  must  point	 to  a
	      valid aMule config file, and then	exit.

       [ --help	]
	      Prints a short usage description.

       [ --version ]
	      Displays the current version number.

       [ --amule-config-file=_path_ ]
	      aMule  config  file path.	 DO NOT	USE DIRECTLY!  aMule uses this
	      option when starting amuleweb at	aMule  startup.	  This	option
	      causes all other command-line and	config-file settings to	be ig-
	      nored, preferences to be read from the given  config  file,  and
	      also implies the -q -L options.

NOTES
   Paths
       For  all	options	which take a _path_ value, if the path contains	no di-
       rectory part (i.e. just a plain filename), then it is considered	to  be
       under the aMule configuration directory,	~/.aMule.

   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 localiza-
       tion data within	a single category.

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

       Though  all  the	 above	strings	are accepted as	valid language defini-
       tions, 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
       amuleweb	is capable  of	displaying  information	 in  different	skins.
       These skins are called templates, and you can make amuleweb load	a spe-
       cific template via the -t command line option.  Templates are  searched
       in   two	  places:   first   in	 ~/.aMule/webserver/   and   then   in
       /usr/share/amule/webserver/ if you installed with --prefix=/usr.

       Each template must be in	a subdirectory of the template name, and  this
       directory must contain all files	the template needs.

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

EXAMPLE
       Typically amuleweb will be first	run as:

       amuleweb	 -h hostname -p	ECport -P ECpassword -s	HTTPport -A AdminPass-
       word -w

       or

       amuleweb	--create-config-from=/home/username/.aMule/amule.conf

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

       amuleweb

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

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

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

SEE ALSO
       amule(1), amulecmd(1)

AUTHOR
       This manpage was	written	by Vollstrecker	<amule@vollstreckernet.de>

aMule webserver	v2.3.2		September 2016			   AMULEWEB(1)

NAME | SYNOPSIS | DESCRIPTION | NOTES | SKIN SUPPORT | FILES | EXAMPLE | REPORTING BUGS | COPYRIGHT | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=amuleweb&sektion=1&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help