yaws - yet another webserver

yaws [OPTIONS]

Yaws is fast lightweight webserver. It can run as daemon or in interactive mode where it is possible to directly interact with the webserver. Yaws is particularly good at generating dynamic content. See the user docs for more information on that topic.

-i

Interactive mode. This will start yaws in interactive mode with an erlang prompt. All error_logger messages will be written to the tty as well in this mode. Use this when developing yaws code.

-D

Daemon mode. This will start yaws as a daemon.

-heart

This will cause the yaws system to be automatically restarted in case it should crash. This switch also require the -D switch to be present.

-d

Debug mode. This will produce some auxilliary error output for some error conditions. It will also start the otp sasl lib for additional error printouts.

-c file

Use a different configuration file than the default. The default configuration file when running as root is /etc/yaws.conf. When running as a non priviliged user, yaws will search for its configuration file in the following order. First in $HOME/yaws.conf, then in ./yaws.conf and finally in /etc/yaws.conf

-r module

Tells yaws to call module:start/0 at startup. This makes it possible to startup user specific applications together with yaws.

-pa path

Add path to the yaws system search path

-t

Traffic trace mode. All traffic will be written to a trace file called trace.traffic in the log directory.

-T

HTTP trace mode. All HTTP messages will be written to a trace file called trace.http in the log directory.

-x

When yaws is put into trace mode using either -T or -t, traces are written to files. If we provide the -x flag, the trace will also be written to stdout.

-M dir

Start Mnesia in directory <dir>

-sname xxx

Start yaws as a distributed erlang node with name <xxx>

-proto_dist Mod

Use module Mod for erlang distribution. This is typically only used when we want to run erlang distribution over SSL.

-erlarg STRING

Pass STRING as an additional argument to the "erl" program.

The following list of options are are used to control the daemon from the "outside" while it is running.

-I id

Only useful with the control commands, -h, -s and -S, -j and -load. It interacts with the yaws server named "id" (as specified in the conf file for that yaws server)

-h [-I id]

HUP the daemon. This forces the daemon to reread the configuration file. It also makes the daemon empty all its internal content caches. Hence when updating the doc root, HUPing the daemon is the fastest way to see the content updates.

-s [-I id]

Stop the daemon (called id)

-ls

Lists current ids and status of all yaws servers on localhost.

-S [-I id]

Query a running yaws daemon for its status, and print it.

-load Modules [-I id]

Try to (re)load erlang modules into a running daemon. This is useful after modifying appmods or modules used by scripts.

-j [-I id] http | traffic | off

Control the trace capabilities of a running yaws daemon. If the http or traffic option is given, the daemon will write a log for debug purposes into the logdir.

-check YawsFile [IncDirs]

Test compile a `.yaws' file.

-v

output version information and exit

Written by Claes Wikstrom

yaws.conf(5) erl(1)