diff --git a/doc/man/call-control-cli.1 b/doc/man/call-control-cli.1 index 5b6862b..d7b9f0f 100644 --- a/doc/man/call-control-cli.1 +++ b/doc/man/call-control-cli.1 @@ -1,57 +1,57 @@ .\" Hey, EMACS: -*- nroff -*- .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) .TH "Call Control CLI" "1" "Aug 13, 2019" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) .SH NAME call\-control\-cli \- Command line interface for Call Control .SH SYNOPSIS .B call-control-cli .RI [ options ] .RI commands .SH DESCRIPTION .PP .\" TeX users may be more comfortable with the \fB\fP and .\" \fI\fP escape sequences to invode bold face and italics, .\" respectively. The \fBcall\-control\-cli\fP command is used for sending requests to a -running \fBcall\-control\fP server. It can either query the running server +running \fBcall\-control\fP engine. It can either query the running server for information about the existing sessions or it can issue commands to administratively terminate sessions. .SH OPTIONS .TP .B \-h, \-\-help Show summary of options. .TP .B \-\-version Show the program version. .TP .B \-\-runtime\-dir=PATH -Set a custom runtime directory (default: \fB/run/callcontrol\fP). Must +Set the runtime directory (default is \fB/run/callcontrol\fP). It must match the runtime directory used by the \fBcall\-control\fP engine. .SH COMMANDS .TP .B list \fI[user]\fP List existing sessions. If user is not specified list all sessions, else list sessions filtered by user. The user argument is taken as a prefix, so it will match any SIP AOR starting with the specified user string. .TP .B show \fIcall\-id\fP Show details about the session identified by \fIcall\-id\fP. .TP .B terminate \fIcall\-id\fP Administratively terminate the session identified by \fIcall\-id\fP. .SH AUTHORS Dan Pascu diff --git a/doc/man/call-control.1 b/doc/man/call-control.1 index e6c2498..95da40d 100644 --- a/doc/man/call-control.1 +++ b/doc/man/call-control.1 @@ -1,65 +1,65 @@ .\" Hey, EMACS: -*- nroff -*- .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) .TH "SIP Call Control" "1" "Aug 13, 2019" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) .SH NAME call\-control \- A SIP call control engine for OpenSIPS .SH SYNOPSIS .B call-control .RI [ options ] .SH DESCRIPTION .PP .\" TeX users may be more comfortable with the \fB\fP and .\" \fI\fP escape sequences to invode bold face and italics, .\" respectively. Call Control is a prepaid application that can be used together with the OpenSIPS call_control module and the CDRTool rating engine to limit the duration of SIP sessions based on a prepaid balance. It can also be used to limit the duration of non-prepaid sessions to a predefined maximum value. .PP Call Control achieves this by maintaining a timer for each session and terminating the call if the session exceeds its allowed time limit or if Call Control receives an external request to terminate the session. .SH OPTIONS .TP .B \-h, \-\-help Show summary of options. .TP .B \-\-version Show the program version. .TP .B \-\-systemd Run the process as a systemd simple service and log to journal. .TP .B \-\-no\-fork Run the process in the foreground and log to the terminal. .TP .B \-\-config\-dir=PATH -Set a custom configuration directory (default: \fB/etc/callcontrol\fP). +Set the configuration directory (default is \fB/etc/callcontrol\fP). .TP .B \-\-runtime\-dir=PATH -Set a custom runtime directory (default: \fB/run/callcontrol\fP). +Set the runtime directory (default is \fB/run/callcontrol\fP). .TP .B \-\-debug Enable verbose logging. .TP .B \-\-debug\-memory Enable memory debugging. .SH AUTHORS Dan Pascu .br Lucian Stanescu .