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.
 
 
 
 
 

65 lines
2.1 KiB

.\" bordeauxctl - send a control message to a bordeaux server
.\" Copyright (C) 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 bordeauxctl "1" "April 2021" "Bordeaux" "Tycho Softworks"
.SH NAME
bordeauxctl \- send a control message to a bordeaux server
.SH SYNOPSIS
.B bordeauxctl
.RI [ options ]
.I command
.RI [ args... ]
.br
.SH DESCRIPTION
Sends a command string to a running bordeaux server, and waits to be
signalled for success or failure. Since command strings are space separated,
the shell can be used to pass cli arguments directly. Content with spaces
can be passed enclosed in a single quote string.
.SH OPTIONS
.TP
.B \-\-quiet
Only return exit code, produce no output.
.TP
.BI \-\-timeout= seconds
Wait to be signaled for specified timeout. The default is 5 seconds.
.TP
.B \-\-help
Outputs help screen for the user.
.SH "EXIT STATUS"
Exit status can be used to determine command results in shell scripts.
.TP
.B 0
Command sent and successfully processed.
.TP
.B 1
Command send resulted in an error or is invalid.
.TP
.B 2
Command timed out without any response signaled.
.TP
.B 3
Error sending to fifo.
.TP
.B 4
Fifo not found or inaccessible.
.SH "REPORTING BUGS"
Report bugs to https://git.gnutelephony.org/bordeaux/issues/new.
.SH COPYRIGHT
Copyright \(co 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.