Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 122 lines (95 sloc) 4.392 kb
21abc5b @klacke Initial revision
authored
1
2 <erl>
3
dbab7a3 @klacke ssi include with var expansion + docs
authored
4 box(Str) ->
5 {'div',[{class,"box"}],
6 {pre,[],Str}}.
961926f @klacke ""
authored
7
8
dbab7a3 @klacke ssi include with var expansion + docs
authored
9 out(A) ->
bea8261 @klacke added log_wrap_size, configurable wrap size for all logs, fixed a bug…
authored
10 [{ssi, "TAB.inc", [],[]},
dbab7a3 @klacke ssi include with var expansion + docs
authored
11 {ehtml,
bea8261 @klacke added log_wrap_size, configurable wrap size for all logs, fixed a bug…
authored
12 [{'div', [{id, "entry"}],
13 [{h1,[],"Build and install"},
14 {p,[], ["Yaws is hosted by the excellent source code site SourceForge ",
15 {a ,[{href,"http://sourceforge.net"}],
16 {img, [{src,"http://sourceforge.net/sflogo.php?group_id=45637&type=1"},
17 {width,"88"},
18 {height,"31"},
19 {border,"0"},
20 {alt,"SourceForge.net Logo"}]}},
21 " The Yaws SourceForge www page is ",
22 {a ,[{href,"http://sourceforge.net/projects/erlyaws/"}],
cd63bee @klacke ""
authored
23 "http://sourceforge.net/projects/erlyaws"}]},
24
25 {p, [], ["Tested releases are downloadable from the yaws website download "
26 " directory, use a regular release unless you plan to hack yaws. "
27 "Regular releases are found at ",
28 {a, [{href, "http://yaws.hyber.org/download"}],
29 "http://yaws.hyber.org/download}"}]},
30
31 {p,[], ["To cvs check out the latest source first install an ",
dbab7a3 @klacke ssi include with var expansion + docs
authored
32 {a, [{href,"http://www.erlang.org"}],"Erlang"},
33 " system, then do: "]},
34 box("
961926f @klacke ""
authored
35 # export CVS_RSH=ssh
36 # export CVSROOT=:pserver:anonymous@cvs.erlyaws.sourceforge.net:/cvsroot/erlyaws
37 # cvs login
38 # cvs -z3 co .
39 # cd yaws; make; make install
dbab7a3 @klacke ssi include with var expansion + docs
authored
40 "),
41
42 {p,[], "The above commands will "
43 "checkout the bleeding edge source, build it and install it at "
d02b965 @klacke qnx port + docs overhaul by cschatz@networkadvantage.biz
authored
44 "127.0.0.1:80 with the docroot set to the local documentation."},
dbab7a3 @klacke ssi include with var expansion + docs
authored
45 {p,[], "Give return as password."},
46 {p,[], "Run ./configure"},
47
48 {p, [], [{tt, [], "make"} ,
cd63bee @klacke ""
authored
49 " (without install) will build the yaws system and ",
dbab7a3 @klacke ssi include with var expansion + docs
authored
50 {tt, [], "make local_install"},
d02b965 @klacke qnx port + docs overhaul by cschatz@networkadvantage.biz
authored
51 " does a local install at http://127.0.0.1:8000. This is the typical mode of operation"
dbab7a3 @klacke ssi include with var expansion + docs
authored
52 " while either just trying out yaws, or hacking yaws. This will install "
53 " a template configuration file yaws.conf in $HOME. "
54 "If $HOME/yaws.conf exists, the old file will not be overwritten. "]},
55
56 {p,[],"A yaws executable (shell script) will be written into "
57 "the $HOME/bin directory."},
58
59 {p,[], "To run a locally installed system, we run the yaws script found in the "
60 " bin directory in the source code tree or $HOME/bin/yaws "},
61
62 {p,[],[
63 {tt,[], "make install"},
64 " will also build the yaws system and also "
65 "install it in /usr/local. A configuration file /etc/yaws.conf will "
66 " also be installed unless the file already exists. The default config "
67 " file will set up the system to listen on http://127.0.0.1:80 "]},
68
69 {h2,[], "Running yaws"},
70 {p,[], ["The yaws executable is a shell script which invokes the "
71 "erlang system and instructs it to start yaws. "
72 " The command line flags for yaws are documented in ",
bea8261 @klacke added log_wrap_size, configurable wrap size for all logs, fixed a bug…
authored
73 {a,[{href, "yman.yaws?page=yaws"}],
dbab7a3 @klacke ssi include with var expansion + docs
authored
74 ["man page for ",
75 {tt, [], "yaws (1)"}]}]},
76
77
78 {p,[], "When developing yaws code, the interactive mode is ideal. Typically "
79 "yaws is then started as: "},
80 {br},
81 box("yaws -i"),
82
83
84 {p, [], "Run yaws as a daemon as"},
85 box("yaws -D"),
86
87 {p,[], "All command line flags to yaws are described in the "
88 "man page for yaws. "},
89
90 {h2,[], "Configuring Yaws"},
91
92 {p,[],["Web server configuration can be supplied to yaws "
93 "in either of two ways depending ",
94 "on whether we run yaws as a standalone daemon or if we run yaws as an "
95 " embedded application inside another Erlang program. "]},
96 {p,[],["The yaws configuration is described in ",
bea8261 @klacke added log_wrap_size, configurable wrap size for all logs, fixed a bug…
authored
97 {a, [{href,"yman.yaws?page=yaws.conf"}],
dbab7a3 @klacke ssi include with var expansion + docs
authored
98 ["man page for ",
99 {tt,[], "yaws.conf (5)"}]}]},
100
101 {h3, [], "Embedded mode"},
102
103 {p,[], ["It is possible to run yaws in embedded mode where yaws is part of a "
104 "larger application. When running yaws in embedded mode, it is often not "
105 " possible to let yaws read its configuration data from /etc/yaws.conf."]},
106
107 {p,[], ["The function ",
108 {tt, [], "yaws_api:setconf(Gconf, Groups)"},
d02b965 @klacke qnx port + docs overhaul by cschatz@networkadvantage.biz
authored
109 "can be used by an other erlang process to explicitly set a yaws configuration at runtime."
110 " To execute Yaws in embedded mode, it must be started with the environment ",
dbab7a3 @klacke ssi include with var expansion + docs
authored
111 {tt, [], "{embedded, true}"},
d02b965 @klacke qnx port + docs overhaul by cschatz@networkadvantage.biz
authored
112 " The embedded mode is fully described at ",
dbab7a3 @klacke ssi include with var expansion + docs
authored
113 {a, [{url, "embed.yaws"}], "embed.yaws"}]}
bea8261 @klacke added log_wrap_size, configurable wrap size for all logs, fixed a bug…
authored
114 ]}]},
115 {ssi, "END2",[],[]}
dbab7a3 @klacke ssi include with var expansion + docs
authored
116 ].
961926f @klacke ""
authored
117
67a6c13 @klacke ""
authored
118 </erl>
cd63bee @klacke ""
authored
119
120
121
Something went wrong with that request. Please try again.