utils/kamctl: updated man pages

utils/kamctl/kamctl.8

@@ -1,7 +1,6 @@
-.\" $Id$
-.TH kamctl 8 05.02.2009 Kamailio "Kamailio" 
+.TH kamctl 8 20.11.2017 Kamailio "Kamailio"
 .\" Process with
-.\" groff -man -Tascii kamctl.8 
+.\" groff -man -Tascii kamctl.8
 .\"
 .SH NAME
 kamctl \- Kamailio control tool
@@ -15,188 +14,35 @@ kamctl \- Kamailio control tool
 .SH DESCRIPTION
 .B kamctl
 is a shell script to control
-.B Kamailio SIP server
+.B Kamailio SIP Server.
+
 It can be used to manage users, domains, aliases and other server options.
 
 
 .SH COMMANDS
-.TP 16
-.I Daemon Commands:
-.TP
-.B start
-Start Kamalio 
-.TP
-.B restart
-Restart Kamalio 
-.TP
-.B stop
-Stop Kamalio 
-.TP
-.B online 
-Display online users
-.TP
-.B monitor
-Show server's internal status
-.TP
-.B ping <uri> 
-Ping <uri> with SIP OPTIONS
-
-
-.TP 16
-.I Access control list (acl)  management commands:
-.TP
-.B acl show [<username>]
-Show user membership
-.TP 
-.B acl grant <username> <group>
-Grant user membership (*)
-.TP
-.B acl revoke <username> [<group>] 
-Grant user membership(s) (*)
-
-.TP 16
-.I  Least cost routes (lcr) management command:
-.TP             
-.B lcr dump
-Show in memory gateways and routes tables
-.TP
-.B lcr reload 
-Reload lcr gateways and routes
-
-.TP 16
-.I Carrierroute tables('cr') management commands:
-.TP
-.B cr show 
-Show tables
-.TP
-.B cr reload 
-Reload tables
-.TP
-.B cr dump 
-Show in memory tables
-.TP
-.B cr addrt <routing_tree_id> <routing_tree> 
-Add a tree
-.TP
-.B cr rmrt  <routing_tree> 
-Remove a tree
-.TP
-.B cr addcarrier <carrier> <scan_prefix> <domain> <rewrite_host> <prob> <strip> <rewrite_prefix> <rewrite_suffix> <flags> <mask> <comment> 
-Add a carrier (prob, strip, rewrite_prefix, rewrite_suffix, flags, mask and comment are optional arguments)
-.TP
-.B cr rmcarrier  <carrier> <scan_prefix> <domain> 
-Remove a carrier
-
-.TP 16
-.I Remote-Party-ID (RPID) management commands:
-.TP
-.B rpid add <username> <rpid>
-Add rpid for a user (*)
-.TP
-.B rpid rm <username>
-Set rpid to NULL for a user (*)
-.TP
-.B rpid show <username>
-Show rpid of a user
-
-.TP 16
-.I Subscriber management commands:
-.TP
-.B add <username> <password> 
- Add a new subscriber (*)
-.TP
-.B passwd <username> <passwd>
-Change user's password (*)
-.TP
-.B rm <username> 
-Delete a user (*)
-
-.TP 16
-.I Commands to manage 'trusted':
-.TP
-.B trusted show 
-Show db content
-.TP
-.B trusted dump 
-Show cache content
-.TP
-.B trusted reload
-Reload db table into cache
-.TP
-.B trusted add <src_ip> <proto> <from_pattern> <tag>
-Add a new entry (from_pattern and tag are optional arguments)
-.TP
-.B trusted rm <src_ip>
-Remove all entres for the given src_ip
-
-.TP 16
-.I Dispatcher management commands:
-.TP
-.B dispatcher show 
-Show dispatcher gateways
-.TP
-.B dispatcher reload 
-Reload dispatcher gateways
-.TP
-.B dispatcher dump 
-Show in memory dispatcher gateways
-.TP
-.B dispatcher addgw <setid> <destination> <flags> <description>
-Add gateway
-.TP
-.B dispatcher rmgw <id> 
-Delete gateway
-
-.TP 16
-.I Cisco restart command:
-.TP
-.B cisco_restart <uri> 
-Restart phone configured for <uri>
-
-.TP 16
-.I User location('ul') or aliases management commands:
-.B ul show [<username>]
-Show in-RAM online users
-.TP
-.B ul show --brief
-Show in-RAM online users in short format
-.TP
-.B ul rm <username> [<contact URI>]
-Delete user's usrloc entries
-.TP
-.B ul add <username> <uri>
-Introduce a permanent usrloc entry
-.TP
-.B ul add <username> <uri> <expires>
-Introduce a temporary usrloc entry
-.TP
-.B ul add <username> <uri> <expires> <path>
-Introduce a temporary usrloc entry including a path
-
-.TP 16
-.I Fifo commands:
-.TP
-.B fifo 
-Send raw FIFO command
-
+Run
+.B kamctl help
+to see the list of available commands.
 
 .SH FILES
 .PD 0
-.I /etc/kamailio/.kamctlrc
+.I /etc/kamailio/kamctlrc
 .br
-.I /usr/local/etc/kamailio/.kamctlrc
+.I /usr/local/etc/kamailio/kamctlrc
 .br
 .I ~/.kamctlrc
 .br
 
 .SH NOTES
 .PP
-Commands labeled with (*) will prompt for a MySQL password.
-If the environment variable PW is set, the password will not be prompted.
+Some commands become available when enabling an RPC engine or a database system
+inside
+.B kamctlrc
+file.
 
 .SH AUTHORS
 
-see 
+see
 .B /usr/share/doc/kamailio/AUTHORS
 
 .SH SEE ALSO
@@ -204,11 +50,13 @@ see
 .BR kamailio.cfg(5)
 .PP
 Full documentation on Kamailio is available at
-.I http://www.kamailio.org/.
+.I https://www.kamailio.org
+
 .PP
 Mailing lists:
-.nf 
[email protected] - Kamailio user community
-.nf 
[email protected] - Kamailio development, new features and unstable version
+
+.nf
[email protected] - Kamailio user community
+.nf
[email protected] - Kamailio development community
 

utils/kamctl/kamdbctl.8

@@ -1,5 +1,4 @@
-.\" $Id$
-.TH kamdbctl 8 05.02.2009 Kamailio "Kamailio"
+.TH kamdbctl 8 20.11.2017 Kamailio "Kamailio"
 .SH NAME
 kamdbctl \- Kamailio database control tool
 .SH SYNOPSIS
@@ -14,60 +13,39 @@ kamdbctl \- Kamailio database control tool
 is a script to maintain the database needed by some Kamalio modules.
 
 .SH Configuration
-Before you can use 
-.B kamdbctl 
+Before you can use
+.B kamdbctl
 you have to select a database engine in the kamctlrc file.
-Just change the DBENGINE parameter in the respective section in kamctlrc.
+Just change the DBENGINE parameter in the respective section in
+.B kamctlrc
+file.
 .TP
 Valid values are: MYSQL, PGSQL, ORACLE, DB_BERKELEY, DBTEXT.
-.TP 
+.TP
 The default is 'none'.
 .TP
 The username, password, database name and other settings can be configured by editing the kamctrl script.
 
 .SH COMMANDS
-.B backup <file> 
-Dumps the current database to a file.
-.TP
-.B copy <new_db> 
-Creates a new database from an existing one.
-.TP
-.B create <db name or db_path, optional> 
-Creates a new database with the specified name, or the default if no name is given.
-.TP
-.B drop <db name or db_path, optional> 
-Entirely deletes the database with the specified name, or the default if no name is given.
-.TP
-.B extra 
-Adds the extra tables
-.TP
-.B migrate <old_db> <new_db> 
-Migrates database tables from an old version to the actual version.
-.TP
-.B presence 
-Adds the presence related tables.
-.TP
-.B reinit <db name or db_path, optional> 
-Entirely deletes and than re-creates tables.
-.TP
-.B restore <file> 
-Restores tables from a file.
+Run
+.B kamdbctl help
+to see the list of available commands.
 
 .SH NOTES
-Not all databases scripts support all commands.
+Several commands are not available for some of the database systems.
 
 .SH FILES
 .PD 0
-.I /etc/kamailio/.kamctlrc
+.I /etc/kamailio/kamctlrc
 .br
-.I /usr/local/etc/kamailio/.kamctlrc
+.I /usr/local/etc/kamailio/kamctlrc
 .br
 .I ~/.kamctlrc
 .br
 
 .SH AUTHORS
 
-see 
+See
 .B /usr/share/doc/kamailio/AUTHORS
 
 .SH SEE ALSO
@@ -75,11 +53,13 @@ see
 .BR kamailio.cfg(5)
 .PP
 Full documentation on Kamailio is available at
-.I http://www.kamailio.org/.
+.I https://www.kamailio.org
+
 .PP
 Mailing lists:
-.nf 
[email protected] - Kamailio user community
-.nf 
[email protected] - Kamailio development, new features and unstable version
+
+.nf
[email protected] - Kamailio user community
+.nf
[email protected] - Kamailio development community