Bordeaux is a voice application server for modern IP telephony networks using modern C++ practices along with advances originally made in GNU Bayonne.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

63 lines
1.9 KiB

.\" sip-ping - test if sip servers are up
.\" Copyright (C) 2020-2021 David Sugar <tychosoft@gmail.com>
.\"
.\" This manual page is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU Lesser General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.\"
.TH sip-ping "1" "December 2020" "Bordeaux" "Tycho Softworks"
.SH NAME
sip-ping \- test if sip servers are up
.SH SYNOPSIS
.B sip-ping
.RI [ options ]
.I uri
.br
.SH DESCRIPTION
Sends an option request to a sip server at the specified uri and waits for a
response, while measuring response time.
.SH OPTIONS
.TP
.B \-6
Enable IPv6 addressing.
.TP
.B \-s
Enable SRV dns lookups.
.TP
.B \-t
Use sip over tcp. The default is udp.
.TP
.BI \-\-config= path
Alternate config file path.
.TP
.BI \-\-proxy= uri
Uri of SIP proxy route.
.TP
.B \-\-info
Show text info of server response message.
.TP
.B \-\-quiet
Quiet one time operation, often used in scripts for getting the exit code.
.TP
.B \-\-help
Outputs help screen for the user.
.SH "EXIT CODES"
Returns 0 if ping is successful, 1 if there is a parsing error, 2 for a sip
error or failure, and 3 for timeout.
.SH "REPORTING BUGS"
Report bugs to https://git.gnutelephony.org/bordeaux/issues/new.
.SH COPYRIGHT
Copyright \(co 2020-2021 David Sugar.
.br
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.