Skip to content

Commit 73ffee7

Browse files
committed
Added note about the possibility of default being overridden by config
See: JoeDog#160 (review)
1 parent c211538 commit 73ffee7

File tree

2 files changed

+128
-128
lines changed

2 files changed

+128
-128
lines changed

INSTALL

Lines changed: 51 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,28 @@
33

44

55
Siege was originally built and tested on GNU/Linux. It has been ported
6-
to other platforms. See the MACHINES document for more details.
6+
to other platforms. See the MACHINES document for more details.
77

88
This program was built using the GNU autoconf mechanism. If you are
9-
familiar with GNU applications, then siege should present few problems
9+
familiar with GNU applications, then siege should present few problems
1010
especially on the above mentioned platforms. For best results, use gcc.
1111

1212
IMPORTANT: If you are upgrading from an earlier version, you MUST delete
1313
the older version before installing this one. The simplest way to remove
14-
the older version to run "make uninstall" in the old source directory.
14+
the older version to run "make uninstall" in the old source directory.
1515
If you no longer have the old source, you can configure the new version
1616
to be installed in the same place as the old version. Then BEFORE you
17-
run "make install", run "make uninstall" first.
17+
run "make install", run "make uninstall" first.
1818

1919
"Hey! I'm impatient, I only read these things when things go wrong!"
2020
If that is the case, then follow the steps in item #1 below...
2121

22-
XXX: If you pulled this code from github.com then you won't have a
23-
configure script. You'll need to build one. How do you do that? In
22+
XXX: If you pulled this code from github.com then you won't have a
23+
configure script. You'll need to build one. How do you do that? In
2424
the top level source directory run this:
2525
$ utils/bootstrap
2626

27-
NOTE: the bootstrap requires GNU autotools in order to run. You'll
27+
NOTE: the bootstrap requires GNU autotools in order to run. You'll
2828
need autoconf, automake and libtool installed on your computer
2929

3030
1. In a nutshell, to install the application in the default directory,
@@ -37,23 +37,23 @@ If that is the case, then follow the steps in item #1 below...
3737
This will install the application ( siege ) in the default directory
3838
/usr/local/bin. If that directory is in your PATH, then to run siege
3939
and view the online help type:
40-
$ siege --help
41-
42-
To learn more about siege, make sure /usr/local/man is in your
40+
$ siege --help
41+
42+
To learn more about siege, make sure /usr/local/man is in your
4343
MANPATH and type:
4444
$ man siege
4545

4646
For more detailed information about running siege and stress testing
4747
HTTP servers, type:
48-
$ man layingsiege
48+
$ man layingsiege
4949

5050
For more details, read on. Especially if you want to install siege
51-
in a directory other that /usr/local/bin
51+
in a directory other that /usr/local/bin
5252

5353
2. Configuration
5454
The configure script attempts to guess the values which are set
5555
on your platform. If all goes well, you should only have to run it
56-
with some preferred arguments. The more notable ones are listed
56+
with some preferred arguments. The more notable ones are listed
5757
below:
5858
--help prints the configure script's help section
5959
--prefix=/some/dir installs the files in /some/dir
@@ -63,13 +63,13 @@ If that is the case, then follow the steps in item #1 below...
6363
flag is used to enable https protocol.
6464

6565

66-
Since siege is a pretty esoteric program, I prefer to install it in
67-
my home directory. For this reason, I run configure with my home
66+
Since siege is a pretty esoteric program, I prefer to install it in
67+
my home directory. For this reason, I run configure with my home
6868
directory as the prefix.
69-
69+
7070
$ ./configure --prefix=/export/home/jdfulmer
7171

72-
If you don't already, make sure $HOME/bin and $HOME/man are set
72+
If you don't already, make sure $HOME/bin and $HOME/man are set
7373
appropriately in your .profile. In my case, I set them like this:
7474

7575
# jdfulmer's profile
@@ -79,23 +79,23 @@ If that is the case, then follow the steps in item #1 below...
7979
export PATH MANPATH
8080
~
8181
~
82-
82+
8383
To reload your profile without logging out, do this:
84-
84+
8585
$ . .profile
8686

87-
If it runs successfully, the configure script creates the Makefiles
88-
which lets you build the program. After you configure your
87+
If it runs successfully, the configure script creates the Makefiles
88+
which lets you build the program. After you configure your
8989
environment, the next step is to build siege. If that step fails, you
90-
may have to return to this step. Reasons for reconfiguring are
91-
mentioned below. If configure failed to create Makefiles, then you
90+
may have to return to this step. Reasons for reconfiguring are
91+
mentioned below. If configure failed to create Makefiles, then you
9292
have problems which may be beyond the scope of this document, such as
93-
no compiler ( you'll have to get one ), no libraries (again, an
93+
no compiler ( you'll have to get one ), no libraries (again, an
9494
acquisition on your part).
9595

9696
HTTPS support
97-
To enable https, you must have ssl installed on your system. Get the
98-
latest version from http://www.openssl.org. AFTER ssl is installed,
97+
To enable https, you must have ssl installed on your system. Get the
98+
latest version from http://www.openssl.org. AFTER ssl is installed,
9999
then you have to configure siege to use it:
100100
$ ./configure --prefix=/some/dir --with-ssl=/ssl/install/dir
101101

@@ -107,30 +107,30 @@ If that is the case, then follow the steps in item #1 below...
107107
$ make install
108108

109109
3. Compilation
110-
To compile the program, execute the second step of the nutshell
111-
version mentioned in item #1: type "make" and hope for the best.
112-
If your environment was configured without errors, then configure
113-
should have generated the Makefiles that will enable this step to
110+
To compile the program, execute the second step of the nutshell
111+
version mentioned in item #1: type "make" and hope for the best.
112+
If your environment was configured without errors, then configure
113+
should have generated the Makefiles that will enable this step to
114114
work.
115115

116116
The make command will invoke your compiler and build siege. If you
117-
are using gcc on any of the platforms mentioned above, then you
118-
should not have problems. In general, any ANSI C compiler should
119-
work.
117+
are using gcc on any of the platforms mentioned above, then you
118+
should not have problems. In general, any ANSI C compiler should
119+
work.
120120

121-
Some systems may require options that were not set by the configure
121+
Some systems may require options that were not set by the configure
122122
script. You can set them using the configure step mentioned above:
123-
$ CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
123+
$ CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
124124

125125
You can also set them by editing the Makefiles that were created as
126-
a result of running configure, but this is not preferred.
126+
a result of running configure, but this is not preferred.
127127

128128
4. Installation
129129
If the program compiled successfully, follow the third nutshell step
130-
and type "make install" This will install the package in the
131-
directories that you've selected in the configuration step. If they
130+
and type "make install" This will install the package in the
131+
directories that you've selected in the configuration step. If they
132132
are not already, make sure PREFIX/bin and PREFIX/man are in your PATH
133-
and MANPATH respectively. This process is described in detail above.
133+
and MANPATH respectively. This process is described in detail above.
134134

135135
Files installed:
136136
siege --> SIEGE_HOME/bin/siege
@@ -143,17 +143,17 @@ If that is the case, then follow the steps in item #1 below...
143143
siege2csv.1 --> SIEGE_HOME/man/man1/siege2csv.1
144144

145145
5. Uninstall
146-
To remove the package, type "make uninstall" To make the source
147-
directory completely clean, type "make distclean". There are
146+
To remove the package, type "make uninstall" To make the source
147+
directory completely clean, type "make distclean". There are
148148
differences of opinion regarding this option. Some people claim that
149-
it should not be available as it depends the original Makefiles from
150-
the source directory. Since I tend to hoard all source code, I like
149+
it should not be available as it depends the original Makefiles from
150+
the source directory. Since I tend to hoard all source code, I like
151151
this feature.
152152

153153
The point is, if you've installed one version of siege in /usr/local
154-
and another version in $HOME, then make uninstall is obviously not
155-
going to work in both locations. The safest thing to do is manually
156-
remove the files which were installed by make install. The files and
154+
and another version in $HOME, then make uninstall is obviously not
155+
going to work in both locations. The safest thing to do is manually
156+
remove the files which were installed by make install. The files and
157157
their locations are described in item #4.
158158

159159
6. Read the documentation
@@ -167,7 +167,8 @@ If that is the case, then follow the steps in item #1 below...
167167
-q, --quiet QUIET turns verbose off and suppresses output.
168168
-g, --get GET, pull down HTTP headers and display the
169169
transaction. Great for application debugging.
170-
-c, --concurrent=NUM CONCURRENT users, default is 25
170+
-c, --concurrent=NUM CONCURRENT users, default is 25 or whatever is
171+
specified in ~/.siegerc
171172
-r, --reps=NUM REPS, number of times to run the test.
172173
-t, --time=NUMm TIMED testing where "m" is modifier S, M, or H
173174
ex: --time=1H, one hour test.
@@ -192,17 +193,17 @@ If that is the case, then follow the steps in item #1 below...
192193
http://www.joedog.org/siege/
193194

194195
OR, read the manual online:
195-
http://www.joedog.org/siege/manual.html
196+
http://www.joedog.org/siege/manual.html
196197

197198
7. Edit the .siege/siege.config file in your home directory. This file
198199
contains runtime directives for siege. Each directive is well
199200
documented with comments. Some directives exist ONLY in this file;
200201
they don't have a command line option. If you are upgrading from an
201-
earlier version, your original version is kept and a new resource
202+
earlier version, your original version is kept and a new resource
202203
file is installed as .siegerc.new. In order to take advantage of any
203204
new directives, you might want to use this new file instead.
204205

205-
--
206+
--
206207

207208
Please consult the file, COPYING for complete license information.
208209

@@ -217,5 +218,3 @@ Permission is granted to distribute modified versions of this
217218
document, or of portions of it, under the above conditions,
218219
provided also that they carry prominent notices stating who last
219220
changed them.
220-
221-

0 commit comments

Comments
 (0)