Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 218 lines (182 sloc) 6.935 kb
639b7c2 @klacke ""
authored
1 .TH YAWS "1" "" "" "User Commands"
2 .SH NAME
3 yaws \- yet another webserver
4 .SH SYNOPSIS
5 .B yaws
6 [\fIOPTIONS\fR]
7 .SH DESCRIPTION
8 .\" Add any additional description here
9 .PP
10 Yaws is fast lightweight webserver. It can run as daemon or
11 in interactive mode where it is possible to directly interact
12 with the webserver. Yaws is particularly good at generating
13 dynamic content. See the user docs for more information on that topic.
14
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
15 .SH DEAMON/SERVER options
16
17
639b7c2 @klacke ""
authored
18 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
19 \fB\-i | --interactive\fR
639b7c2 @klacke ""
authored
20 Interactive mode. This will start yaws in interactive mode with an erlang
21 prompt. All error_logger messages will be written to the tty as well in this
22 mode. Use this when developing yaws code.
23 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
24 \fB\-w | --winteractive\fR
25 Cygwin inteactive mode (werl)
814bae1 @klacke cleaned up the redirect feature. It was poorly implemented and poorly do...
authored
26 .TP
27 \fB\-D | --daemon\fR
639b7c2 @klacke ""
authored
28 Daemon mode. This will start yaws as a daemon.
29 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
30 \fB\--heart\fR
a2a82e3 Added the -heart switch
Tobbe Tornquist authored
31 This will cause the yaws system to be automatically restarted
2ba5805 @vinoski add new --heart-restart option to allow control over heart restarts
vinoski authored
32 in case it should crash. This switch also requires the \fI--daemon\fR
a2a82e3 Added the -heart switch
Tobbe Tornquist authored
33 switch to be present.
34 .TP
2ba5805 @vinoski add new --heart-restart option to allow control over heart restarts
vinoski authored
35 \fB\--heart-restart=C,T\fR
36 This controls the number of restarts in a given time period that heart
37 tolerates before refusing to restart Yaws. By default, heart allows up
38 to 5 restarts within a 60 second period before refusing to restart
39 Yaws again. This option allows up to \fIC\fR restarts in \fIT\fR
40 seconds instead. To allow infinite restarts, set both \fIC\fR and
41 \fIT\fR to 0. This switch automatically enables the \fI--heart\fR
42 switch.
43 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
44 \fB\--debug\fR
2ba5805 @vinoski add new --heart-restart option to allow control over heart restarts
vinoski authored
45 Debug mode. This will produce some auxiliary error output for some
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
46 error conditions. It will also start the otp sasl lib for additional
47 error printouts.
48
639b7c2 @klacke ""
authored
49 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
50 \fB\--conf file\fR
639b7c2 @klacke ""
authored
51 Use a different configuration file than the default. The default configuration file
52 when running as root is /etc/yaws.conf. When running as a non priviliged user, yaws
53 will search for its configuration file in the following order. First in
54 $HOME/yaws.conf, then in ./yaws.conf and finally in /etc/yaws.conf
55 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
56 \fB\--runmod module\fR
22fd788 Added the '-r <Mod>' switch.
Tobbe Tornquist authored
57 Tells yaws to call \fImodule:start/0\fR at startup. This makes it possible
58 to startup user specific applications together with yaws.
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
59
60 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
61 \fB\--pa path\fR
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
62 Add path to the yaws system search path
63
22fd788 Added the '-r <Mod>' switch.
Tobbe Tornquist authored
64 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
65 \fB\--tracetraf\fR
639b7c2 @klacke ""
authored
66 Traffic trace mode. All traffic will be written to a trace file called trace.traffic
67 in the log directory.
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
68
639b7c2 @klacke ""
authored
69 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
70 \fB\--tracehttp\fR
639b7c2 @klacke ""
authored
71 HTTP trace mode. All HTTP messages will be written to a trace file called trace.http
72 in the log directory.
82d6e29 @klacke added -x flag for tty trace and did the 1.3 release
authored
73
74 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
75 \fB\--traceout\fR
76 When yaws is put into trace mode using either --tracetraf or --tracehttp, traces are written to files. If we provide the --traceout flag, the trace will also be written to stdout.
82d6e29 @klacke added -x flag for tty trace and did the 1.3 release
authored
77
c7c87a4 @klacke -sname and mnesia flag added to start script
authored
78 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
79 \fB\--trace\fR
80 Sames as --tracetraf --traceout. I.e. trace everything and write to stdout.
81
82 .TP
83 \fB\--mnesiadir dir\fR
c7c87a4 @klacke -sname and mnesia flag added to start script
authored
84 Start Mnesia in directory <dir>
85
86 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
87 \fB\--sname xxx\fR
c7c87a4 @klacke -sname and mnesia flag added to start script
authored
88 Start yaws as a distributed erlang node with name <xxx>
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
89 using the unqualified hostname as nodename postfix
90
91 .TP
a90bd68 @klacke added kpoll as default
authored
92 \fB\--disable-kpoll\fR
93 By default, yaws starts erlang with \fI+K true\fR. This flag
94 reverses that.
95
96 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
97 \fB\--name xxx\fR
98 Start yaws as a distributed erlang node with name <xxx> using the
99 fully qualified hostname as nodename postfix
82d6e29 @klacke added -x flag for tty trace and did the 1.3 release
authored
100
37e9d70 @klacke -erlarg patch by Fredrik Thulin
authored
101 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
102 \fB\--proto_dist Mod\fR
37e9d70 @klacke -erlarg patch by Fredrik Thulin
authored
103 Use module Mod for erlang distribution. This is typically only used
104 when we want to run erlang distribution over SSL.
105
106 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
107 \fB\--erlarg STRING\fR
37e9d70 @klacke -erlarg patch by Fredrik Thulin
authored
108 Pass STRING as an additional argument to the "erl" program.
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
109
110
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
111 .TP
112 \fB\--id ID\fR
113 This flag sets the id. If we're starting a daemon (or an interactive
114 system) it gives the Yaws server the identity ID. This means that the
115 server will write all internal files into the directory
c9778e0 @klacke added support for 2 additional configure
authored
116 $HOME/.yaws/ID.
117
118 Yaws also creates a file called
119 ${VARDIR}/run/yaws/ctl-${ID} which contains the portnumber the daemon
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
120 is listening on for control request by the control command such
121 as "yaws --hup" etc.
122
123 If we're invoking a control command which should perform some
c9778e0 @klacke added support for 2 additional configure
authored
124 control function on the daemon, we may have to give the --id flag also
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
125 to the control command. If we don't do this the control command
126 may interact with the wrong daemon due to finding the wrong "ctl" file.
127
128 The daemon may also optionally specify the "id" in the yaws.conf
129 configuration file.
130
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
131 .SH CONTROL OPTIONS
132 .PP
133 The following list of options are are used to control the daemon
134 from the "outside" while it is running.
135
639b7c2 @klacke ""
authored
136 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
137 \fB\--hup [--id ID]\fR
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
138 HUP the daemon. This forces the daemon to reread the configuration file.
139 It also makes
140 the daemon empty all its internal content caches.
141 Hence when updating the doc root,
639b7c2 @klacke ""
authored
142 HUPing the daemon is the fastest way to see the content updates.
143 .TP
674c8b3 @klacke git-svn-id: https://erlyaws.svn.sourceforge.net/svnroot/erlyaws/trunk/ya...
authored
144 \fB\--stop [--id id]\fR
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
145 Stop the daemon (called id)
639b7c2 @klacke ""
authored
146 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
147 \fB\--ls \fR
148 Lists current ids and status of all yaws servers on localhost. In practice this
149 amounts to a listdir in $HOME/.yaws/yaws - and check wether the different
150 systems who has created files there are alive.
d659ba3 @klacke added a 'yaws -ls' command that lists all yaws servers on localhost
authored
151 .TP
674c8b3 @klacke git-svn-id: https://erlyaws.svn.sourceforge.net/svnroot/erlyaws/trunk/ya...
authored
152 \fB--status [--id id]\fR
6155cc4 @carsten3347 -S, -load, -check
carsten3347 authored
153 Query a running yaws daemon for its status, and print it.
154 .TP
674c8b3 @klacke git-svn-id: https://erlyaws.svn.sourceforge.net/svnroot/erlyaws/trunk/ya...
authored
155 \fB--load Modules [--id id]\fR
6155cc4 @carsten3347 -S, -load, -check
carsten3347 authored
156 Try to (re)load erlang modules into a running daemon. This is useful
157 after modifying appmods or modules used by scripts.
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
158
159 .TP
5207102 @klacke Added debug dump functionality
authored
160 \fB--debug-dump [--id id]\fR
161 Produce a debug dump on stdout. In particular this code lists what
162 we refer to as suspicious processes. I.e. processes that might be
163 hanging or processes that are "large" - hardcoded to 40k words.
164
165 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
166 \fB--ctltrace [--id ID] http | traffic | off\fR
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
167 Control the trace capabilities of a running yaws daemon. If the
168 http or traffic option is given, the daemon will write a log
169 for debug purposes into the logdir.
170
ddf3bee @klacke preparing for 1.78
authored
171 .TP
2ba5805 @vinoski add new --heart-restart option to allow control over heart restarts
vinoski authored
172 \fB--wait-started[=T] [--id ID] \fR
ddf3bee @klacke preparing for 1.78
authored
173 Waits at most 5 seconds for the server to start. Exits with 0 if
2ba5805 @vinoski add new --heart-restart option to allow control over heart restarts
vinoski authored
174 server is running, 1 otherwise. Typically useful in test scripts. The
175 default 5 seconds can be modified by appending \fI=T\fR to the option,
176 where \fIT\fR is the desired number of seconds to wait for the server
177 to start.
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
178
179 .SH MISC OPTIONS
180
6155cc4 @carsten3347 -S, -load, -check
carsten3347 authored
181 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
182 \fB--check YawsFile [IncDirs ....]\fR
183 Test compile a `.yaws' file. Useful in Makefiles when we want to ensure
184 that all .yaws files are syntactically correct
6155cc4 @carsten3347 -S, -load, -check
carsten3347 authored
185 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
186 \fB\--version\fR
639b7c2 @klacke ""
authored
187 output version information and exit
5f13a9c @klacke Two patches by Joseph Wayen Norton, one dbg-bug and one providing better...
authored
188
189 .SH ENVIRONMENT VARIABLES
190 .TP
191 \fBHOME\fR
192 Is used to determine where we write the temporary files. By default
193 all tmp files end up in $HOME/.yaws. This includes the JIT files
194 that are the result of processed .yaws files and also the so called
195 control file that is used by the daemon to write the port number
196 to which it is listening for control commands such as "yaws --status"
197
198 Thus HOME is the handle we use in the control commands to
199 find the control file so that we know where to connect to.
200
201 .TP
202 \fBYAWSHOME\fR
203 Can be used to override the HOME variable. This is useful when we
204 for example are running yaws under port binding programs such as
205 authpriv.
206
207 It's useful by distros that don't want Yaws to write any files
208 ever in the HOME directory of root.
209
210
211
639b7c2 @klacke ""
authored
212 .SH AUTHOR
213 Written by Claes Wikstrom
214 .SH "SEE ALSO"
215 .BR yaws.conf (5)
216 .BR erl (1)
217
Something went wrong with that request. Please try again.