Skip to content
Newer
Older
100644 113 lines (91 sloc) 4.04 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) ->
10 [{ssi, "HEAD", [],[]},
11 {ssi, "TOPTAB", [],[]},
12 {ehtml,
13 [{h2,[],"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/"}],
23 "http://sourceforge.net/projects/erlyaws"}
24 ]},
25 {p,[], ["To cvs check out the latest source first install an ",
26 {a, [{href,"http://www.erlang.org"}],"Erlang"},
27 " system, then do: "]},
28 box("
961926f @klacke ""
authored
29 # export CVS_RSH=ssh
30 # export CVSROOT=:pserver:anonymous@cvs.erlyaws.sourceforge.net:/cvsroot/erlyaws
31 # cvs login
32 # cvs -z3 co .
33 # cd yaws; make; make install
dbab7a3 @klacke ssi include with var expansion + docs
authored
34 "),
35
36 {p,[], "The above commands will "
37 "checkout the bleeding edge source, build it and install it at "
38 "127.0.0.1:80 with the docroot set to the local documentation"},
39 {p,[], "Give return as password."},
40 {p,[], "Run ./configure"},
41
42 {p, [], [{tt, [], "make"} ,
43 "(without install) will build the yaws system and ",
44 {tt, [], "make local_install"},
45 "does a local install at http://127.0.0.1:8000. This is the typical mode of operation"
46 " while either just trying out yaws, or hacking yaws. This will install "
47 " a template configuration file yaws.conf in $HOME. "
48 "If $HOME/yaws.conf exists, the old file will not be overwritten. "]},
49
50 {p,[],"A yaws executable (shell script) will be written into "
51 "the $HOME/bin directory."},
52
53 {p,[], "To run a locally installed system, we run the yaws script found in the "
54 " bin directory in the source code tree or $HOME/bin/yaws "},
55
56 {p,[],[
57 {tt,[], "make install"},
58 " will also build the yaws system and also "
59 "install it in /usr/local. A configuration file /etc/yaws.conf will "
60 " also be installed unless the file already exists. The default config "
61 " file will set up the system to listen on http://127.0.0.1:80 "]},
62
63 {h2,[], "Running yaws"},
64 {p,[], ["The yaws executable is a shell script which invokes the "
65 "erlang system and instructs it to start yaws. "
66 " The command line flags for yaws are documented in ",
67 {a,[{href, "man.yaws?page=yaws"}],
68 ["man page for ",
69 {tt, [], "yaws (1)"}]}]},
70
71
72 {p,[], "When developing yaws code, the interactive mode is ideal. Typically "
73 "yaws is then started as: "},
74 {br},
75 box("yaws -i"),
76
77
78 {p, [], "Run yaws as a daemon as"},
79 box("yaws -D"),
80
81 {p,[], "All command line flags to yaws are described in the "
82 "man page for yaws. "},
83
84 {h2,[], "Configuring Yaws"},
85
86 {p,[],["Web server configuration can be supplied to yaws "
87 "in either of two ways depending ",
88 "on whether we run yaws as a standalone daemon or if we run yaws as an "
89 " embedded application inside another Erlang program. "]},
90 {p,[],["The yaws configuration is described in ",
91 {a, [{href,"man.yaws?page=yaws.conf"}],
92 ["man page for ",
93 {tt,[], "yaws.conf (5)"}]}]},
94
95 {h3, [], "Embedded mode"},
96
97 {p,[], ["It is possible to run yaws in embedded mode where yaws is part of a "
98 "larger application. When running yaws in embedded mode, it is often not "
99 " possible to let yaws read its configuration data from /etc/yaws.conf."]},
100
101 {p,[], ["The function ",
102 {tt, [], "yaws_api:setconf(Gconf, Groups)"},
103 "can be used by an other erlang process to explicitly set a yaws configuration at runtime.."
104 "To execute Yaws in embedded mode, it must be started with the environment ",
105 {tt, [], "{embedded, true}"},
106 "The embedded mode is fully described at ",
107 {a, [{url, "embed.yaws"}], "embed.yaws"}]}
108 ]},
109 {ssi, "END",[],[]}
110 ].
961926f @klacke ""
authored
111
67a6c13 @klacke ""
authored
112 </erl>
Something went wrong with that request. Please try again.