diff options
author | Russell Bryant <russell@russellbryant.com> | 2007-10-15 13:12:51 +0000 |
---|---|---|
committer | Russell Bryant <russell@russellbryant.com> | 2007-10-15 13:12:51 +0000 |
commit | 4765cf4553924050a3c0bfa581efaba8ffc50c55 (patch) | |
tree | 10e1f9eaad925e0834d16a91560765b0c2259636 /doc/tex/manager.tex | |
parent | 27031927cf43efe9922557c011d282a0486d40aa (diff) |
Another major doc directory update from IgorG. This patch includes
- Many uses of the astlisting environment around verbatim text to ensure that
it gets properly formatted and doesn't run off the page.
- Update some things that have been deprecated.
- Add escaping as needed
- and more ...
(closes issue #10978)
Reported by: IgorG
Patches:
texdoc-85542-1.patch uploaded by IgorG (license 20)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@85547 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'doc/tex/manager.tex')
-rw-r--r-- | doc/tex/manager.tex | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/doc/tex/manager.tex b/doc/tex/manager.tex index 192587cda..c3b567bd4 100644 --- a/doc/tex/manager.tex +++ b/doc/tex/manager.tex @@ -15,9 +15,9 @@ generate an initial response and data in the form list of events. This format is created to make sure that extensive reports do not block the manager interface fully. -Management users are configured in the configuration file manager.conf and are -given permissions for read and write, where write represents their ability -to perform this class of "action", and read represents their ability to +Management users are configured in the configuration file manager.conf and are +given permissions for read and write, where write represents their ability +to perform this class of "action", and read represents their ability to receive this class of "event". If you develop AMI applications, treat the headers @@ -40,16 +40,17 @@ subscriptions and call limits) \section{Command Syntax} -Management communication consists of tags of the form "header: value", -terminated with an empty newline (\textbackslash r\textbackslash n) in the style of SMTP, HTTP, and -other headers. +Management communication consists of tags of the form "header: value", +terminated with an empty newline (\textbackslash r\textbackslash n) in +the style of SMTP, HTTP, and other headers. The first tag MUST be one of the following: \begin{itemize} - \item Action: An action requested by the CLIENT to the Asterisk SERVER. Only one "Action" may be outstanding at any time. + \item Action: An action requested by the CLIENT to the Asterisk SERVER. + Only one "Action" may be outstanding at any time. \item Response: A response to an action from the Asterisk SERVER to the CLIENT. - \item Event: An event reported by the Asterisk SERVER to the CLIENT + \item Event: An event reported by the Asterisk SERVER to the CLIENT \end{itemize} \section{Manager commands} @@ -107,7 +108,7 @@ Redirect with ExtraChannel: Where 680 is an extension that sends you to a MeetMe room. There are a number of GUI tools that use the manager interface, please search -the mailing list archives and the documentation page on the +the mailing list archives and the documentation page on the \url{http://www.asterisk.org} web site for more information. @@ -117,7 +118,7 @@ the mailing list archives and the documentation page on the AccountCode: -- Account Code (cdr_manager) ACL: <Y | N> -- Does ACL exist for object ? Action: <action> -- Request or notification of a particular action - Address-IP: -- IPaddress + Address-IP: -- IPaddress Address-Port: -- IP port number Agent: <string> -- Agent name AMAflags: -- AMA flag (cdr_manager, sippeers) @@ -130,12 +131,12 @@ the mailing list archives and the documentation page on the BillableSeconds: -- Billable seconds for call (cdr_manager) CallerID: -- Caller id (name and number in Originate & cdr_manager) CallerID: -- CallerID number - Number or "<unknown>" or "unknown" + Number or "<unknown>" or "unknown" (should change to "<unknown>" in app_queue) CallerID1: -- Channel 1 CallerID (Link event) CallerID2: -- Channel 2 CallerID (Link event) CallerIDName: -- CallerID name - Name or "<unknown>" or "unknown" + Name or "<unknown>" or "unknown" (should change to "<unknown>" in app_queue) Callgroup: -- Call group for peer/user CallsTaken: <num> -- Queue status variable @@ -188,19 +189,19 @@ the mailing list archives and the documentation page on the Loginchan: -- Login channel for agent Logintime: <number> -- Login time for agent Mailbox: -- VM Mailbox (id@vmcontext) (mailboxstatus, mailboxcount) - MD5SecretExist: <Y | N> -- Whether secret exists in MD5 format + MD5SecretExist: <Y | N> -- Whether secret exists in MD5 format Membership: <string> -- "Dynamic" or "static" member in queue Message: <text> -- Text message in ACKs, errors (explanation) - Mix: <bool> -- Boolean parameter (monitor) + Mix: <bool> -- Boolean parameter (monitor) NewMessages: <count> -- Count of new Mailbox messages (mailboxcount) - Newname: + Newname: ObjectName: -- Name of object in list OldName: -- Something in Rename (channel.c) - OldMessages: <count> -- Count of old mailbox messages (mailboxcount) + OldMessages: <count> -- Count of old mailbox messages (mailboxcount) Outgoinglimit: -- SIP Peer outgoing limit Paused: <num> -- Queue member paused status Peer: <tech/name> -- "channel" specifier :-) - PeerStatus: <tech/name> -- Peer status code + PeerStatus: <tech/name> -- Peer status code "Unregistered", "Registered", "Lagged", "Reachable" Penalty: <num> -- Queue penalty Priority: -- Extension priority @@ -218,8 +219,8 @@ the mailing list archives and the documentation page on the Reason: -- Originate reason code Seconds: -- Seconds (Status) Secret: <password> -- Authentication secret (for login) - SecretExist: <Y | N> -- Whether secret exists - Shutdown: -- "Uncleanly", "Cleanly" + SecretExist: <Y | N> -- Whether secret exists + Shutdown: -- "Uncleanly", "Cleanly" SIP-AuthInsecure: SIP-FromDomain: -- Peer FromDomain SIP-FromUser: -- Peer FromUser |