Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 166 lines (139 sloc) 5.048 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)
26 \fB\--daemon\fR
639b7c2 @klacke ""
authored
27 Daemon mode. This will start yaws as a daemon.
28 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
29 \fB\--heart\fR
a2a82e3 Added the -heart switch
Tobbe Tornquist authored
30 This will cause the yaws system to be automatically restarted
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
31 in case it should crash. This switch also require the \fI--daemon\fR
a2a82e3 Added the -heart switch
Tobbe Tornquist authored
32 switch to be present.
33 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
34 \fB\--debug\fR
639b7c2 @klacke ""
authored
35 Debug mode. This will produce some auxilliary error output for some
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
36 error conditions. It will also start the otp sasl lib for additional
37 error printouts.
38
639b7c2 @klacke ""
authored
39 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
40 \fB\--conf file\fR
639b7c2 @klacke ""
authored
41 Use a different configuration file than the default. The default configuration file
42 when running as root is /etc/yaws.conf. When running as a non priviliged user, yaws
43 will search for its configuration file in the following order. First in
44 $HOME/yaws.conf, then in ./yaws.conf and finally in /etc/yaws.conf
45 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
46 \fB\--runmod module\fR
22fd788 Added the '-r <Mod>' switch.
Tobbe Tornquist authored
47 Tells yaws to call \fImodule:start/0\fR at startup. This makes it possible
48 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
49
50 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
51 \fB\--pa path\fR
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
52 Add path to the yaws system search path
53
22fd788 Added the '-r <Mod>' switch.
Tobbe Tornquist authored
54 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
55 \fB\--tracetraf\fR
639b7c2 @klacke ""
authored
56 Traffic trace mode. All traffic will be written to a trace file called trace.traffic
57 in the log directory.
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
58
639b7c2 @klacke ""
authored
59 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
60 \fB\--tracehttp\fR
639b7c2 @klacke ""
authored
61 HTTP trace mode. All HTTP messages will be written to a trace file called trace.http
62 in the log directory.
82d6e29 @klacke added -x flag for tty trace and did the 1.3 release
authored
63
64 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
65 \fB\--traceout\fR
66 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
67
c7c87a4 @klacke -sname and mnesia flag added to start script
authored
68 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
69 \fB\--trace\fR
70 Sames as --tracetraf --traceout. I.e. trace everything and write to stdout.
71
72 .TP
73 \fB\--mnesiadir dir\fR
c7c87a4 @klacke -sname and mnesia flag added to start script
authored
74 Start Mnesia in directory <dir>
75
76 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
77 \fB\--sname xxx\fR
c7c87a4 @klacke -sname and mnesia flag added to start script
authored
78 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
79 using the unqualified hostname as nodename postfix
80
81 .TP
82 \fB\--name xxx\fR
83 Start yaws as a distributed erlang node with name <xxx> using the
84 fully qualified hostname as nodename postfix
82d6e29 @klacke added -x flag for tty trace and did the 1.3 release
authored
85
37e9d70 @klacke -erlarg patch by Fredrik Thulin
authored
86 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
87 \fB\--proto_dist Mod\fR
37e9d70 @klacke -erlarg patch by Fredrik Thulin
authored
88 Use module Mod for erlang distribution. This is typically only used
89 when we want to run erlang distribution over SSL.
90
91 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
92 \fB\--erlarg STRING\fR
37e9d70 @klacke -erlarg patch by Fredrik Thulin
authored
93 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
94
95
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
96 .TP
97 \fB\--id ID\fR
98 This flag sets the id. If we're starting a daemon (or an interactive
99 system) it gives the Yaws server the identity ID. This means that the
100 server will write all internal files into the directory
c9778e0 @klacke added support for 2 additional configure
authored
101 $HOME/.yaws/ID.
102
103 Yaws also creates a file called
104 ${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
105 is listening on for control request by the control command such
106 as "yaws --hup" etc.
107
108 If we're invoking a control command which should perform some
c9778e0 @klacke added support for 2 additional configure
authored
109 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
110 to the control command. If we don't do this the control command
111 may interact with the wrong daemon due to finding the wrong "ctl" file.
112
113 The daemon may also optionally specify the "id" in the yaws.conf
114 configuration file.
115
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
116 .SH CONTROL OPTIONS
117 .PP
118 The following list of options are are used to control the daemon
119 from the "outside" while it is running.
120
639b7c2 @klacke ""
authored
121 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
122 \fB\--hup [--id ID]\fR
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
123 HUP the daemon. This forces the daemon to reread the configuration file.
124 It also makes
125 the daemon empty all its internal content caches.
126 Hence when updating the doc root,
639b7c2 @klacke ""
authored
127 HUPing the daemon is the fastest way to see the content updates.
128 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
129 \fB\--stop [-I id]\fR
dc00e52 @klacke postvar bug by hal snyder, added yaws_api:query_url/1 added the id suppo...
authored
130 Stop the daemon (called id)
639b7c2 @klacke ""
authored
131 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
132 \fB\--ls \fR
133 Lists current ids and status of all yaws servers on localhost. In practice this
134 amounts to a listdir in $HOME/.yaws/yaws - and check wether the different
135 systems who has created files there are alive.
d659ba3 @klacke added a 'yaws -ls' command that lists all yaws servers on localhost
authored
136 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
137 \fB--status [-I id]\fR
6155cc4 @carsten3347 -S, -load, -check
carsten3347 authored
138 Query a running yaws daemon for its status, and print it.
139 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
140 \fB--load Modules [-I id]\fR
6155cc4 @carsten3347 -S, -load, -check
carsten3347 authored
141 Try to (re)load erlang modules into a running daemon. This is useful
142 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
143
144 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
145 \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
146 Control the trace capabilities of a running yaws daemon. If the
147 http or traffic option is given, the daemon will write a log
148 for debug purposes into the logdir.
149
150
151 .SH MISC OPTIONS
152
6155cc4 @carsten3347 -S, -load, -check
carsten3347 authored
153 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
154 \fB--check YawsFile [IncDirs ....]\fR
155 Test compile a `.yaws' file. Useful in Makefiles when we want to ensure
156 that all .yaws files are syntactically correct
6155cc4 @carsten3347 -S, -load, -check
carsten3347 authored
157 .TP
92bafb4 @klacke removed the ability change userid, also stopped writing to /tmp/yaws and...
authored
158 \fB\--version\fR
639b7c2 @klacke ""
authored
159 output version information and exit
160 .SH AUTHOR
161 Written by Claes Wikstrom
162 .SH "SEE ALSO"
163 .BR yaws.conf (5)
164 .BR erl (1)
165
Something went wrong with that request. Please try again.