[Pkg-voip-commits] r7829 - in /opensips/trunk/debian: changelog osipsconsole.8 rules

alerios at alioth.debian.org alerios at alioth.debian.org
Sun Nov 22 21:22:41 UTC 2009 

Author: alerios
Date: Sun Nov 22 21:22:41 2009
New Revision: 7829

URL: http://svn.debian.org/wsvn/pkg-voip/?sc=1&rev=7829
Log:
 * Added osipsconsole.8 man page.

Added:
    opensips/trunk/debian/osipsconsole.8
Modified:
    opensips/trunk/debian/changelog
    opensips/trunk/debian/rules

Modified: opensips/trunk/debian/changelog
URL: http://svn.debian.org/wsvn/pkg-voip/opensips/trunk/debian/changelog?rev=7829&op=diff
==============================================================================
--- opensips/trunk/debian/changelog (original)
+++ opensips/trunk/debian/changelog Sun Nov 22 21:22:41 2009
@@ -5,7 +5,7 @@
   [ Alejandro Rios ]
   * Initial version after fork from openser (Closes: #556131).
   * Add myself to uploaders.
-  * Build-depend on python-all-dev.
+  * Build-depend on python-all-dev and python-support.
   * Add ${misc:Depends} to binary packages (thanks lintian)
   * Upgrade to Standards-Version 3.8.3 (no change needed)
   * Added README.source
@@ -13,6 +13,7 @@
   * Depend on python.
   * Depend on some perl modules to use osipsconsole.
   * Remove INSTALL from package.
+  * Added osipsconsole.8 man page.
 
   [ Kilian Krause ]
   * debian/control: 

Added: opensips/trunk/debian/osipsconsole.8
URL: http://svn.debian.org/wsvn/pkg-voip/opensips/trunk/debian/osipsconsole.8?rev=7829&op=file
==============================================================================
--- opensips/trunk/debian/osipsconsole.8 (added)
+++ opensips/trunk/debian/osipsconsole.8 Sun Nov 22 21:22:41 2009
@@ -1,0 +1,233 @@
+.\" $Id: osipsconsole.8 5891 2009-11-22 12:53:09Z alerios $
+.TH osipsconsole 8 22.11.2009 opensips "OpenSIPS" 
+.\" Process with
+.\" groff -man -Tascii osipsconsole.8 
+.\"
+.SH NAME
+osipsconsole \- utility for provisioning OpenSIPS
+.SH SYNOPSIS
+.B osipsconsole
+
+.B osipsconsole
+.BI command
+[
+.BI parameters
+]
+
+.SH DESCRIPTION
+.B osipsconsole
+is a is a console like utility for provisioning
+.B OpenSIPS SIP server
+It can be used to manage users, domains, aliases and other server options. If
+command arguments are passed it will work in non-interactive mode, and behave
+as old opensipsctl and opensipsdbctl tools.
+If no arguments are passed, it behaves as a console - you will get a prompt,
+and can run the available commands, with embedded help and command history -.
+
+.SH FILES
+.PD 0
+.I /etc/opensips/osipsconsolerc
+.br
+.I ~/.osipsconsolerc
+.br
+
+.SH COMMANDS
+.TP 12
+.B help
+Displays a short usage description, including all available options.
+.TP
+.B moni
+show internal status
+.TP
+.B ps
+show running processes
+.TP
+.B fifo
+send raw FIFO commands
+.TP
+.B ping <uri>
+ping a URI (OPTIONS)
+.TP
+.B cisco_restart <uri>
+restart a Cisco phone (NOTIFY)
+.TP 16
+.I SUBSCRIBER management:
+.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
+.B alias show [<alias>]
+show aliases
+.TP
+.B alias rm <alias>
+remove an alias
+.TP
+.B alias add <alias> <uri> 
+add an aliases
+.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
+.B alias_db show <alias>
+show alias details
+.TP
+.B alias_db list <sip-id>
+list aliases for uri
+.TP
+.B alias_db add <alias> <sip-id>
+add an alias (*)
+.TP
+.B alias_db rm <alias>
+remove an alias (*)
+.TP
+.B alias_db help
+help message
+.TP
+.B speeddial show <speeddial-id>
+show speeddial details
+.TP
+.B speeddial list <sip-id>
+list speeddial for uri
+.TP
+.B speeddial add <sip-id> <sd-id> <new-uri> [<desc>]
+add a speedial (*)
+.TP
+.B speeddial rm <sip-id> <sd-id>
+remove a speeddial (*)
+.TP
+.B speeddial help
+help message
+.TP 16
+.I AVP management:
+.TP
+.B avp list [-T table] [-u <sip-id|uuid>] \
+[-a attribute] [-v value] [-t type]
+list AVPs
+.TP
+.B avp add [-T table] <sip-id|uuid> \
+<attribute> <type> <value>
+add AVP (*)
+.TP
+.B avp rm [-T table]  [-u <sip-id|uuid>] \
+[-a attribute] [-v value] [-t type]
+remove AVP (*)
+.TP
+.B avp help
+help message
+.TP 16
+.I ACL (Access Control Lists) management
+.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 USRLOC (User Location) management
+.TP
+.B ul show [<username>]
+show in-RAM online users
+.TP
+.B ul rm <username> [<contact URI>]
+delete user's UsrLoc entries
+.TP
+.B ul add <username> <uri>
+introduce a permanent UrLoc entry
+.TP
+.B ul add <username> <uri> <expires>
+introduce a temporary UrLoc entry
+.TP
+.B showdb [<username>]
+show online users flushed in DB
+.TP 16
+.I DOMAIN management
+.TP
+.B domain show
+show list of served domains
+.TP
+.B domain add <domainname>
+add a new served domain
+.TP
+.B domain rm <domainname>
+remove a served domain
+.TP 16
+.I LCR (Least Cost Routing) management
+.TP
+.B lcr show
+show routes, gateways and groups
+.TP
+.B lcr reload
+reload lcr gateways
+.TP
+.B lcr addgw <gw_name> <ip> <port> <scheme> <transport> <grp_id>
+add a gateway
+.TP
+.B lcr addgw <gw_name> <ip> <port> <scheme> <transport> <grp_id> <prefix>
+add a gateway with prefix
+.TP
+.B lcr addgw <gw_name> <ip> <port> <scheme> <transport> <grp_id> \
+<prefix> <strip>
+add a gateway with prefix and strip
+.TP
+.B lcr rmgw  <gw_name>
+delete a gateway
+.TP
+.B lcr addroute <prefix> <from> <grp_id> <prio>
+add a route
+.TP
+.B lcr rmroute  <prefix> <from> <grp_id> <prio>
+delete a route
+
+.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.
+.PP
+IP addresses must be entered in dotted quad format e.g. 1.2.3.4
+<uri_scheme> and <transport> must be entered in integer or text,
+e.g. transport '2' is identical to transport 'tcp'.
+.br
+scheme: 1=sip, 2=sips;   transport: 1=udp, 2=tcp, 3=tls
+.br
+Examples:
+.br
+lcr addgw level3 1.2.3.4 5080 sip tcp 1
+.br
+lcr addroute +1 '' 1 1
+
+.SH AUTHORS
+
+see 
+.B /usr/share/doc/opensips/AUTHORS
+.PP
+This manual page was written by Alejandro Rios P. <alerios at debian.org>,
+based on opensipsctl manpage by Bogdan-Andrei Iancu <bogdan at voice-system.ro>,
+for the Debian project (and may be used by others).
+
+.SH SEE ALSO
+.BR opensips(8), opensips.cfg(5), opensipsctl(8)
+.PP
+Full documentation on opensips is available at
+.I http://www.opensips.org/.
+.PP
+Mailing lists:
+.nf 
+users at opensips.org - opensips user community
+.nf 
+devel at opensips.org - opensips development, new features and unstable version

Modified: opensips/trunk/debian/rules
URL: http://svn.debian.org/wsvn/pkg-voip/opensips/trunk/debian/rules?rev=7829&op=diff
==============================================================================
--- opensips/trunk/debian/rules (original)
+++ opensips/trunk/debian/rules Sun Nov 22 21:22:41 2009
@@ -326,7 +326,7 @@
 #	dh_installlogrotate
 	dh_installinit -popensips -- defaults 23
 	dh_installcron
-	dh_installman
+	dh_installman debian/osipsconsole.8
 	dh_installinfo
 	dh_installchangelogs
 	dh_link

More information about the Pkg-voip-commits mailing list