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