| 1 |
.\" $Revision: 3.10.0 $ |
| 2 |
.TH TESTHOST 1 |
| 3 |
.SH NAME |
| 4 |
testhost - test the status of an NNTP news server |
| 5 |
.SH SYNOPSIS |
| 6 |
.I testhost |
| 7 |
.BI hostname |
| 8 |
[ |
| 9 |
.BI -a | -n |
| 10 |
date time |
| 11 |
.BI | -o |
| 12 |
] |
| 13 |
[ |
| 14 |
.BI -M |
| 15 |
] |
| 16 |
[ |
| 17 |
.BI -s | -S |
| 18 |
filename |
| 19 |
] |
| 20 |
[ |
| 21 |
.BI -e | -E |
| 22 |
filename |
| 23 |
] |
| 24 |
[ |
| 25 |
.BI -N |
| 26 |
port_number |
| 27 |
] |
| 28 |
[ |
| 29 |
.BI -U |
| 30 |
userid |
| 31 |
] |
| 32 |
[ |
| 33 |
.BI -P |
| 34 |
password |
| 35 |
] |
| 36 |
[ |
| 37 |
.BI -Q |
| 38 |
] |
| 39 |
[ |
| 40 |
.BI -l |
| 41 |
phrase_file |
| 42 |
] |
| 43 |
[ |
| 44 |
.BI -T |
| 45 |
timeout |
| 46 |
] |
| 47 |
[ |
| 48 |
.BI -d |
| 49 |
] |
| 50 |
[ |
| 51 |
.BI -q |
| 52 |
] |
| 53 |
[ |
| 54 |
.BI -z |
| 55 |
] |
| 56 |
|
| 57 |
.SH OPTIONS |
| 58 |
-a Get the active list from hostname |
| 59 |
|
| 60 |
\-d |
| 61 |
|
| 62 |
This option tells testhost get the descriptions of the newsgroups on the |
| 63 |
remote server by sending the 'list newsgroups' command. The remote server |
| 64 |
may or may not support this command. |
| 65 |
|
| 66 |
-e | -E filename |
| 67 |
|
| 68 |
These options will send all error messages (normally displayed on stderr), to |
| 69 |
an alternate file. The lower case version, -e, will send the error messages |
| 70 |
to the compiled-in default defined in suck_config.h. The default is suck.errlog. |
| 71 |
The upper case version, -E, requires the filename parameter. All error messages |
| 72 |
will then be sent to this file. |
| 73 |
|
| 74 |
\-l phrase_file |
| 75 |
|
| 76 |
This option tells testhost to load in an alternate phrase file, instead of using |
| 77 |
the built-in messages. This allows you to have testhost print phrases in another |
| 78 |
language, or to allow you to customize the messages without re-building. |
| 79 |
See the "FOREIGN LANGUAGE PHRASES" in suck.1 for more details. |
| 80 |
|
| 81 |
-n date time |
| 82 |
|
| 83 |
Get the newgroups created on the host since the date and |
| 84 |
time specified. The date must be in YYMMDD format and the time must be in |
| 85 |
HHMMSS format. |
| 86 |
|
| 87 |
-N port_number |
| 88 |
|
| 89 |
This option will tell testhost to use an alternate NNRP port number when connecting |
| 90 |
to the host, instead of the default, 119. |
| 91 |
|
| 92 |
\-q |
| 93 |
|
| 94 |
This option tells testhost to not display the connection and announcement messages, |
| 95 |
rather only display the results of the actual command run. |
| 96 |
|
| 97 |
-s | -S filename |
| 98 |
|
| 99 |
These options will send all status messages (normally displayed on stdout), to |
| 100 |
an alternate file. The lower case version, -s, will send the status messages |
| 101 |
to the compiled-in default defined in suck_config.h. The default is /dev/null, |
| 102 |
so no status messages will be displayed. The upper case version, -S, requires |
| 103 |
the filename parameter. All status messages will then be sent to this file. |
| 104 |
|
| 105 |
\-T |
| 106 |
|
| 107 |
This option overrides the compiled-in TIMEOUT value. This is how long testhost |
| 108 |
waits for data from the remote host before timing out and aborting. |
| 109 |
|
| 110 |
\-U userid |
| 111 |
|
| 112 |
\-P password |
| 113 |
|
| 114 |
These two options let you specify a userid and password, if your NNTP server |
| 115 |
requires them. |
| 116 |
|
| 117 |
\-Q |
| 118 |
|
| 119 |
This option tells testhost to use the environment variable NNTP_USER & NNTP_PASS |
| 120 |
to specify a userid and password, if your NNTP server requires them. This option |
| 121 |
is provided so that the userid & password can't be seen with the ps command, a |
| 122 |
potential security problem. |
| 123 |
|
| 124 |
\-z |
| 125 |
|
| 126 |
This options tells testhost to use SSL to talk to the remote server, if testhost |
| 127 |
was compiled with SSL. |
| 128 |
|
| 129 |
.SH DESCRIPTION |
| 130 |
.I Testhost |
| 131 |
will query a NNTP news server, specified by |
| 132 |
.I hostname. |
| 133 |
|
| 134 |
The hostname may optionally include the port number in the form |
| 135 |
.BI Host:Port. If the port number is included, the port number specified |
| 136 |
by the -N option will be ignored. |
| 137 |
|
| 138 |
The default action is to issue the |
| 139 |
.I help |
| 140 |
command to the server, to see what software it is running |
| 141 |
and what commands it accepts. |
| 142 |
.PP |
| 143 |
If the |
| 144 |
.I -a |
| 145 |
option is used, testhost will display the server's |
| 146 |
active history list. If the |
| 147 |
.I -n date time |
| 148 |
option is used, testhost will display all new groups created on the server |
| 149 |
since the date and time specified. If the |
| 150 |
.I -o |
| 151 |
option is used, then testhost will display the overview format, which is |
| 152 |
what the XOVER command returns. |
| 153 |
.PP |
| 154 |
If the |
| 155 |
.I -M |
| 156 |
option is used, the command will be preceded with the "mode reader" command, |
| 157 |
which might be needed by some servers. |
| 158 |
|
| 159 |
.SH EXIT VALUES |
| 160 |
0 on success, -1 on failure. |
| 161 |
.de R$ |
| 162 |
This is revision \\$3, \\$4. |
| 163 |
.. |
| 164 |
.SH "SEE ALSO" |
| 165 |
suck(1), rpost(1), lpost(1). |