Package: sipsak
Version: 0.9.6-1
Attached you find a diff correcting a bunch of spelling mistakes in the
man page - including a few things I wasn't quite sure how to correct,
so please have a close look before applying ;-)
--- sipsak.1.orig 2006-01-28 22:11:34.000000000 +0100
+++ sipsak.1 2006-02-26 15:11:21.000000000 +0100
@@ -71,7 +71,7 @@
.IP "- message mode (-M)"
Sends a short message (similar to SMS from the mobile phones) to a given
target. With the option
.BR -B
-the content of the MESSAGE can be set. Usefull might be the options
+the content of the MESSAGE can be set. Useful might be the options
.BR -c
and
.BR -O
@@ -79,7 +79,7 @@
.IP "- usrloc mode (-U)"
Stress mode for SIP registrar.
.B sipsak
-keeps registering to a SIP server at high pace. Additionaly the registrar
+keeps registering to a SIP server at high pace. Additionally the registrar
can be stressed with the
.BR -I
or the
@@ -117,12 +117,12 @@
.IP "-a, --password PASSWORD"
With the given
.I PASSWORD
-an authentication will be tryed on received '401 Unauthorized'. Authorization
-will be tryed on time. If this option is omitted an authorization with an
-empty password ("") will be tryed. If the password is equal to
+an authentication will be tried on received '401 Unauthorized'.
Authorization(Authentication?)
+will be tried on time(? one time?). If this option is omitted an
authorization(authentication?) with an
+empty password ("") will be tried. If the password is equal to
.I -
the password will be read from the standard input (e.g. the keyboard). This
-prevents other users on the same host from seeing the password the password
+prevents other users on the same host from seeing the password
in the process list.
.B NOTE:
the password still can be read from the memory if other users have access to
@@ -135,7 +135,7 @@
.BR -v
were given this option will be ignored.
-.IP "-b, --apendix-begin NUMBER"
+.IP "-b, --appendix-begin NUMBER"
The starting number which is appended to the user name in the usrloc mode.
This
.I NUMBER
@@ -155,8 +155,8 @@
.B sipsak
runs in the message mode (initiated with the
.BR -M
-option). This is helpfull to present the receiver of a MESSAGE a meaningfull
-and usable address to where maybe even responses can be send.
+option). This is helpful to present the receiver of a MESSAGE a meaningful
+and usable address to where maybe even responses can be sent.
.IP "-C, --contact SIPURI"
This is the content of the Contact header in the usrloc mode. This allows
@@ -174,7 +174,7 @@
.IP "-d, --ignore-redirects"
If this option is set all redirects will be ignored. By default without this
-option received redirects will be respected. This option is automaticly
+option received redirects will be respected. This option is automatically
activated in the randtrash mode and in the flood mode.
.IP "-D, --timeout-factor NUMBER"
@@ -188,7 +188,7 @@
The ending number which is appended to the user name in the usrloc mode.
This number is increased until it reaches this ending
.I number.
-In the flood mode this is the maximum number of messages which will be send.
+In the flood mode this is the maximum number of messages which will be sent.
If omitted the default value is 2^31 (2147483647) in the flood mode.
.IP "-E, --transport STRING"
@@ -211,7 +211,7 @@
.I -
the file is read from standard input, e.g. from the keyboard or a pipe.
Please note that the manipulation functions (e.g. inserting Via header)
-are only tested with RFC conform requests. Additionaly special strings
+are only tested with RFC conform requests. Additionally special strings
within the file can be replaced with some local or given values (see
.BR -g
and
@@ -219,7 +219,7 @@
for details).
.IP "-F, --flood-mode"
-This options activates the flood mode. In this mode OPTIONS requests with
+This option activates the flood mode. In this mode OPTIONS requests with
increasing CSeq numbers are sent to the server. Replies are ignored --
source port 9 (discard) of localhost is advertised in topmost Via.
@@ -229,10 +229,10 @@
is available it will print out a help message with the available long options.
.IP "-g, --replace-string STRING"
-Activates the replacement of $replace$ within the request (usualy read
+Activates the replacement of $replace$ within the request (usually read
in from a file) with the
.I STRING.
-Alternatively you can also specify a list of attribute and values.
+Alternatively you can also specify a list of attributes and values.
This list has to start and end with a non alpha-numeric character. The
same character has to be used also as seperator between the attribute and
the value and between new further attribute value pairs. The string
@@ -240,9 +240,9 @@
.IP "-G, --replace"
Activates the automatic replacement of the following variables in the
-request (usualy read in from a file):
+request (usually read in from a file):
.B $dsthost$
-will be replaced by with the host or domainname which is given
+will be replaced with the host or domainname which is given
by the
.B -s
parameter.
@@ -259,7 +259,7 @@
.IP "-H, --hostname HOSTNAME"
Overwrites the automatic detection of the hostname with the given parameter.
.B Warning:
-use this with caution (preferable only if the automatic detection fails).
+use this with caution (preferably only if the automatic detection fails).
.IP "-i, --no-via"
Deactivates the insertion of the Via line of the localhost.
@@ -267,14 +267,14 @@
this probably disables the receiving of the responses from the server.
.IP "-I, --invite-mode"
-Activates the Invites cycles within the usrloc mode. It should be combined
+Activates the invites cycles within the usrloc mode. It should be combined
with
.BR -U.
In this combination
.B sipsak
-first registeres a user, and then simulates an
-invitation to this user. First an Invite is sent, this is replied with 200 OK
-and finaly an ACK is sent. This option can also be used without
+first registers a user, and then simulates an
+invitation to this user. First an invite is sent, this is replied with 200 OK
+and finally an ACK is sent. This option can also be used without
.BR -U
, but you should be sure to NOT invite real UAs with this option. In the case
of a missing
@@ -288,7 +288,7 @@
and the same fixed local port can be successful.
.B Warning: sipsak
is no real UA and invitations to real UAs can result in unexpected
-behaivior.
+behaviour.
.IP "-j, --headers STRING"
The
@@ -336,7 +336,7 @@
can cause unexpected behaivor.
.IP "-n, --numeric"
-Instead of the full qualified domain name in the Via line the IP of the
+Instead of the fully qualified domain name in the Via line the IP of the
local host will be used. This option is now on by default.
.IP "-N, --nagios-code"
@@ -360,14 +360,14 @@
.IP "-p, --outbound-proxy HOSTNAME[:PORT]"
the address of the hostname is the target where the request will be sent to
-(outgoing proxy). Use this if the destination host is different then the host
+(outgoing proxy). Use this if the destination host is different from the host
part of the request uri. The hostname is resolved via DNS SRV if supported
(see description for SRV resolving) and no port is given.
.IP "-P, --processes NUMBER"
Start
.BR NUMBER
-of processes in parallel to do the send and reply checking. Makes only sence
+of processes in parallel to do the send and reply checking. Makes only sense
if a higher number for
.BR -e
is given in the usrloc, message or invite mode.
@@ -387,8 +387,8 @@
parameter.
.IP "-R, --random-mode"
-This activates the randtrash mode. In this mode OPTIONS requests will be send
-to server with increasing numbers of randomly crashed characters within this
+This activates the randtrash mode. In this mode OPTIONS requests will be sent
+to server with increasing numbers of randomly crashed(?) characters within this
request. The position within the request and the replacing character are
randomly chosen. Any other response than Bad request (4xx) will stop this
mode. Also three unresponded sends will stop this mode. With the
@@ -397,7 +397,7 @@
.IP "-s, --sip-uri SIPURI"
This mandatory option sets the destination of the request. It depends on the
-mode if only the server name or also an user name is mandatory. Example for a
+mode if only the server name or also a user name is mandatory. Example for a
full
.BR SIPURI
:
@@ -437,16 +437,16 @@
.IP "-T, --traceroute-mode"
This activates the traceroute mode. This mode works like the well known
.BR traceroute(8)
-command expect that not the number of network hops are counted rather
-the number of server on the way to the destination user. Also the round trip
+command except that not the number of network hops is counted, but
+the number of servers on the way to the destination user. Also the round trip
time of each request is printed out, but due to a limitation within the
-sip protocol the identity (IP or name) can only determined and printed
+sip protocol the identity (IP or name) can only be determined and printed
out if the response from the server contains a warning header field. In this
mode on each outgoing request the value of the Max-Forwards header field is
-increased, starting with one. The maximum of the Max-Forwards header will 255
+increased, starting with one. The maximum of the Max-Forwards header will be
255
if no other value is given by the
.BR -m
-parameter. Any other response than 483 or 1xx are treated as a final response
+parameter. Any other response than 483 or 1xx is treated as a final response
and will terminate this mode.
.IP "-u, --auth-username STRING"
@@ -461,12 +461,12 @@
or the
.BR -M
option, this only registers users at a registrar. With one of the above
-options the previous registered user will also be probed ether with a
+options the previous registered user will also be probed, wether with a
simulated call flow (invite, 200, ack) or with an instant message
(message, 200). One password for all users accounts within the usrloc test
can be given with the
.BR -a
-option. An user name is mandatory for this mode in the
+option. A user name is mandatory for this mode in the
.BR -s
parameter. The number starting from the
.BR -b
@@ -476,14 +476,14 @@
.BR -b
and the
.BR -e
-parameter are omitted, only one runs with the given username, but without
-append number to the usernames is done.
+parameter are omitted, only one run with the given username, but without
+an appended number to the username is done.
.IP "-v, --verbose"
This parameter increases the output verbosity. No
.BR -v
means nearly no output except in traceroute and error messages. The maximum
-of three v's prints out the content of all packets received and sent.
+of three 'v's prints out the content of all packets received and sent.
.IP "-V, --version"
Prints out the name and version number of
@@ -502,13 +502,13 @@
.IP "-z, --remove-bindings"
Activates the randomly removing of old bindings in the usrloc mode. How many
-per cent of the bindings will be removed, is determined by the
+percent of the bindings will be removed, is determined by the
USRLOC_REMOVE_PERCENT define within the code (set it before compilation).
Multiple removing of bindings is possible, and cannot be prevented.
.SH RETURN VALUES
The return value 0 means that a 200 was received. 1 means something else
-then 1xx or 2xx was received.
+than 1xx or 2xx was received.
2 will be returned on local errors like non resolvable names or
wrong options combination. 3 will be returned on remote errors like socket
errors (e.g. icmp error), redirects without a contact header or simply
