docs/man/amuleweb.1

   1 .TH AMULEWEB 1 "August 2008" "aMule webserver v2.2.2" "aMule utilities"
   2 .SH NAME
   3 amuleweb \- aMule web server
   4 .SH SYNOPSIS
   5 .B amuleweb
   6 .RB [ \-h " " \fI<host> ]
   7 .RB [ \-p " " \fI<port> ]
   8 .RB [ \-P " " \fI<passwd> ]
   9 .RB [ \-f " " \fI<path> ]
  10 .RB [ \-q ]
  11 .RB [ \-v ]
  12 .RB [ \-l " " \fI<lang> ]
  13 .RB [ \-w ]
  14 .RB [ \-t " " \fI<name> ]
  15 .RB [ \-s " " \fI<port> ]
  16 .RB [ \-u ]
  17 .RB [ \-U ]
  18 .RB [ \-z ]
  19 .RB [ \-Z ]
  20 .RB [ \-A " " \fI<pass> ]
  21 .RB [ \-G " " \fI<pass> ]
  22 .RB [ \-a ]
  23 .RB [ \-d ]
  24 .RB [ \-L ]
  25 .RB [ \-N ]
  26 .PP
  27 .B amuleweb
  28 .RB [ \-f " " \fI<path> ]
  29 .B \-\-create-config-from=\fI<path>
  30 .PP
  31 .B amuleweb
  32 .RB [ \-\-help ]
  33 .RB [ \-\-version ]
  34 .PP
  35 .B amuleweb \-\-amule\-config\-file=\fI<path>
  36 .PP
  37 .B amuleweb \-\-no\-php
  38 .SH DESCRIPTION
  39 \fBamuleweb\fR manages your access to amule through a web browser.
  40 You can start amuleweb together with \fBamule\fR(1), or separately, any time later.
  41 Options can be specified via command-line or via config-file.
  42 Command-line options take precedence over config-file options.
  43 .TP
  44 \fB\-h\fR, \fB\-\-host\fR=\fI<host>\fR
  45 Host where aMule is running (default: \fIlocalhost\fR).
  46 \fI<host>\fR might be an IP address or a DNS name.
  47 .TP
  48 \fB\-p\fR, \fB\-\-port\fR=\fI<port>\fR
  49 aMule's port for External Connections, as set in Preferences->Remote Controls (default: \fI4712\fR).
  50 .TP
  51 \fB\-P\fR, \fB\-\-password\fR=\fI<passwd>\fR.
  52 External Connections password.
  53 .TP
  54 \fB\-f\fR, \fB\-\-config\-file\fR=\fI<path>\fR
  55 Uses the given configuration file.
  56 Default configuration file is \fI~/.aMule/remote.conf\fR .
  57 .TP
  58 \fB\-q\fR, \fB\-\-quiet\fR
  59 Does not print any output to stdout.
  60 You may want to use \fB\-q\fR to daemonize the webserver, i.e. running as '\fBamuleweb \-q &\fR'.
  61 .TP
  62 \fB\-v\fR, \fB\-\-verbose\fR
  63 Be verbose \- show also debug messages.
  64 .TP
  65 \fB\-l\fR, \fB\-\-locale\fR=\fI<lang>\fR
  66 Sets program locale (language).
  67 See section \fBLANGUAGES\fR for the description of the \fI<lang>\fR parameter.
  68 .TP
  69 \fB\-w\fR, \fB\-\-write\-config\fR
  70 Writes command line options to config file and exit.
  71 .TP
  72 \fB\-\-create\-config\-from\fR=\fI<path>\fR
  73 Creates config file based upon \fI<path>\fR, which must point to a valid aMule config file, and then exit.
  74 .TP
  75 \fB\-t\fR, \fB\-\-template\fR=\fI<name>\fR
  76 Loads the template named \fI<name>\fR. See also the section
  77 .B SKIN SUPPORT.
  78 .TP
  79 \fB\-s\fR, \fB\-\-server\-port\fR=\fI<port>\fR
  80 Webserver's HTTP port. This is the port you can point your browser to (default: \fI4711\fR).
  81 .TP
  82 \fB\-z\fR, \fB\-\-enable\-upnp\fR
  83 Enables use of UPnP port forwarding on web server port.
  84 .TP
  85 \fB\-U\fR, \fB\-\-upnp\-port\fR
  86 UPnP port.
  87 .TP
  88 \fB\-z\fR, \fB\-\-enable\-gzip\fR
  89 Enables using gzip compression in HTTP traffic to save bandwidth.
  90 .TP
  91 \fB\-Z\fR, \fB\-\-disable\-gzip\fR
  92 Disables using gzip compression (this is the default).
  93 .TP
  94 \fB\-A\fR, \fB\-\-admin\-pass\fR=\fI<passwd>\fR
  95 Full access password for webserver.
  96 .TP
  97 \fB\-G\fR, \fB\-\-guest\-pass\fR=\fI<passwd>\fR
  98 Guest password for webserver.
  99 .TP
 100 \fB\-a\fR, \fB\-\-allow\-guest\fR
 101 Allows guest access.
 102 .TP
 103 \fB\-d\fR, \fB\-\-deny\-guest\fR
 104 Denies guest access (default).
 105 .TP
 106 \fB\-L\fR, \fB\-\-load\-settings\fR
 107 Load/save webserver settings from/to remote aMule.
 108 This causes amuleweb to ignore command-line and config-file settings, and load them from aMule.
 109 When saving preferences none will be written to the config file, but to aMule.
 110 (Of course, this works only for those settings that can be set in aMule's Preferences->Remote Controls.)
 111 .TP
 112 \fB\-N\fR, \fB\-\-no\-script\-cache\fR
 113 Recompiles PHP pages on each request.
 114 .TP
 115 \fB\-\-amule\-config\-file\fR=\fI<path>\fR
 116 aMule config file path.
 117 .B DO NOT USE DIRECTLY!
 118 aMule uses this option when starting amuleweb at aMule startup.
 119 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 \fB\-q \-L\fR options.
 120 .TP
 121 \fB\-\-help\fR
 122 Prints a short usage description.
 123 .TP
 124 \fB\-\-version\fR
 125 Displays the current version number.
 126 .SH NOTES
 127 .SS Paths
 128 For all options which take a \fI<path>\fR value, if the \fIpath\fR contains no
 129 directory part (i.e. just a plain filename), then it is considered to be under
 130 the aMule configuration directory, \fI~/.aMule\fR.
 131 .SS LANGUAGES
 132 The \fI<lang>\fR parameter for the \fB\-l\fR option has the following form: \fIlang\fR[\fB_\fILANG\fR][\fB.\fIencoding\fR][\fB@\fImodifier\fR]
 133 where \fIlang\fR is the primary language, \fILANG\fR is a sublanguage/territory,
 134 \fIencoding\fR is the character set to use and \fImodifier\fR
 135 "allows the user to select a specific instance of localization data within a
 136 single category".
 137 .PP
 138 For example, the following strings are valid:
 139 .br
 140 de
 141 .br
 142 de_DE
 143 .br
 144 de_DE.iso88591
 145 .br
 146 de_DE@euro
 147 .br
 148 de_DE.iso88591@euro
 149 .PP
 150 Though all the above strings are accepted as valid language definitions,
 151 \fIencoding\fR and \fImodifier\fR are yet unused.
 152 .PP
 153 In addition to the format above, you can also specify full language names in
 154 English - so \fB\-l german\fR is also valid and is equal to \fB-l de_DE\fR.
 155 .PP
 156 When no locale is defined, either on command-line or in config file, system
 157 default language will be used.
 158 .SH SKIN SUPPORT
 159 \fBamuleweb\fR is capable of displaying information in different skins.
 160 These skins are called templates, and you can make amuleweb load a specific template via the \fB\-t\fR command line option.
 161 Templates are searched in two places: first in \fI~/.aMule/webserver/\fR and then in \fI$(pkgdatadir)/webserver/\fR
 162 (\fI$(pkgdatadir)\fR is the install location of architecture independent data, most likely something like /usr/share/amule).
 163 Each template must be in a subdirectory of the template name, and this directory must contain all files the template needs.
 164 The actual template filename must be aMule.tmpl.
 165 .PP
 166 For example, the default template (named 'default') is in webserver/default/, and this directory contains aMule.tmpl amongst a lot of image files.
 167 .SH FILES
 168 ~/.aMule/remote.conf
 169 .br
 170 ~/.aMule/webserver/
 171 .br
 172 \fI$(pkgdatadir)\fR/webserver/
 173 .SH EXAMPLE
 174 Typically amuleweb will be first run as:
 175 .PP
 176 \fBamuleweb\fR \fB\-h\fR \fIhostname\fR \fB\-p\fR \fIECport\fR \fB\-P\fR \fIECpassword\fR \fB\-s\fR \fIHTTPport\fR \fB\-A\fR \fIAdminPassword\fR \fB\-w\fR
 177 .PP
 178 or
 179 .PP
 180 \fBamuleweb\fR \fB\-\-create-config-from\fR=\fI/home/username/.aMule/amule.conf\fR
 181 .PP
 182 These will save settings to \fI$HOME/.aMule/remote.conf\fR, and later you only need to type:
 183 .PP
 184 .B amuleweb
 185 .PP
 186 Of course, you may specify any more or less options on the first example line, and you may also totally omit it.
 187 .SH REPORTING BUGS
 188 Please report bugs either on our forum (\fIhttp://forum.amule.org/\fR), or in our bugtracker (\fIhttp://bugs.amule.org/\fR).
 189 Please do not report bugs in e-mail, neither to our mailing list nor directly to any team member.
 190 .SH COPYRIGHT
 191 aMule and all of its related utilities are distributed under the GNU General Public License.
 192 .SH SEE ALSO
 193 \fBamule\fR(1), \fBamulecmd\fR(1)