| blob | c2ea00918a4ff150b7b6a92139d95cd631cd9aae |
1 .TH AMULEWEB 1 "January 2010" "aMule webserver v2.3.0" "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 also the section
77 .B SKIN SUPPORT.
78 .TP
79 \fB[ \-s\fR \fI<port>\fR, \fB\-\-server\-port\fR=\fI<port>\fR \fB]\fR
80 Webserver's HTTP port. This is the port you can point your browser to (default: \fI4711\fR).
81 .TP
82 .B_untranslated [ \-u ]\fR
83 .br
84 Enable UPnP.
85 .TP
86 \fB[ \-U\fR \fI<port>\fR, \fB\-\-upnp\-port\fR \fI<port>\fR \fB]\fR
87 UPnP port.
88 .TP
89 .B_untranslated [ \-z\fR, \fB\-\-enable\-gzip ]\fR
90 Enables using gzip compression in HTTP traffic to save bandwidth.
91 .TP
92 .B_untranslated [ \-Z\fR, \fB\-\-disable\-gzip ]\fR
93 Disables using gzip compression (this is the default).
94 .TP
95 \fB[ \-A\fR \fI<passwd>\fR, \fB\-\-admin\-pass\fR=\fI<passwd>\fR \fB]\fR
96 Full access password for webserver.
97 .TP
98 \fB[ \-G\fR \fI<passwd>\fR, \fB\-\-guest\-pass\fR=\fI<passwd>\fR \fB]\fR
99 Guest password for webserver.
100 .TP
101 .B_untranslated [ \-a\fR, \fB\-\-allow\-guest ]\fR
102 Allows guest access.
103 .TP
104 .B_untranslated [ \-d\fR, \fB\-\-deny\-guest ]\fR
105 Denies guest access (default).
106 .TP
107 .B_untranslated [ \-L\fR, \fB\-\-load\-settings ]\fR
108 Load/save webserver settings from/to remote aMule.
109 This causes amuleweb to ignore command-line and config-file settings, and load them from aMule.
110 When saving preferences none will be written to the config file, but to aMule.
111 (Of course, this works only for those settings that can be set in aMule's Preferences->Remote Controls.)
112 .TP
113 .B_untranslated [ \-\-no\-php ]\fR
114 Disable PHP interpreter (deprecated)
115 .TP
116 .B_untranslated [ \-N\fR, \fB\-\-no\-script\-cache ]\fR
117 Recompiles PHP pages on each request.
118 .TP
119 \fB[ \-\-create\-config\-from\fR=\fI<path>\fR \fB]\fR
120 Create config file based upon \fI<path>\fR, which must point to a valid aMule config file, and then exit.
121 .TP
122 .B_untranslated [ \-\-help ]\fR
123 Prints a short usage description.
124 .TP
125 .B_untranslated [ \-\-version ]\fR
126 Displays the current version number.
127 .TP
128 \fB[ \-\-amule\-config\-file\fR=\fI<path>\fR \fB]\fR
129 aMule config file path.
130 .B DO NOT USE DIRECTLY!
131 aMule uses this option when starting amuleweb at aMule startup.
132 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.
133 .SH NOTES
134 .SS Paths
135 For all options which take a \fI<path>\fR value, if the \fIpath\fR contains no
136 directory part (i.e. just a plain filename), then it is considered to be under
137 the aMule configuration directory, \fI~/.aMule\fR.
138 .SS Languages
139 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]
140 where \fIlang\fR is the primary language, \fILANG\fR is a sublanguage/territory,
141 \fIencoding\fR is the character set to use and \fImodifier\fR
142 allows the user to select a specific instance of localization data within a
143 single category.
145 For example, the following strings are valid:
146 .RS
147 .RB_untranslated de
148 .br
149 .RB_untranslated de_DE
150 .br
151 .RB_untranslated de_DE.iso88591
152 .br
153 .RB_untranslated de_DE@euro
154 .br
155 .RB_untranslated de_DE.iso88591@euro
156 .RE
158 Though all the above strings are accepted as valid language definitions,
159 \fIencoding\fR and \fImodifier\fR are yet unused.
161 In addition to the format above, you can also specify full language names in
162 English - so \fB\-l german\fR is also valid and is equal to \fB\-l de_DE\fR.
164 When no locale is defined, either on command-line or in config file, system
165 default language will be used.
166 .SH SKIN SUPPORT
167 \fBamuleweb\fR is capable of displaying information in different skins.
168 These skins are called templates, and you can make amuleweb load a specific template via the \fB\-t\fR command line option.
169 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.
170 .PP
171 Each template must be in a subdirectory of the template name, and this directory must contain all files the template needs.
172 .SH FILES
173 ~/.aMule/remote.conf
174 .br
175 ~/.aMule/webserver/
176 .br
177 \fI$(pkgdatadir)\fR/webserver/
178 .SH EXAMPLE
179 Typically amuleweb will be first run as:
180 .PP
181 \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
182 .PP
183 or
184 .PP
185 \fBamuleweb\fR \fB\-\-create-config-from\fR=\fI/home/username/.aMule/amule.conf\fR
186 .PP
187 These will save settings to \fI$HOME/.aMule/remote.conf\fR, and later you only need to type:
188 .PP
189 .B_untranslated amuleweb
190 .PP
191 Of course, you may specify any more or less options on the first example line, and you may also totally omit it.
192 .SH REPORTING BUGS
193 Please report bugs either on our forum (\fIhttp://forum.amule.org/\fR), or in our bugtracker (\fIhttp://bugs.amule.org/\fR).
194 Please do not report bugs in e-mail, neither to our mailing list nor directly to any team member.
195 .SH COPYRIGHT
196 aMule and all of its related utilities are distributed under the GNU General Public License.
197 .SH SEE ALSO
198 .B_untranslated amule\fR(1), \fBamulecmd\fR(1)
199 .SH AUTHOR
200 This manpage was written by Vollstrecker <amule@vollstreckernet.de>