summaryrefslogtreecommitdiff
path: root/apps/app_alarmreceiver.c
diff options
context:
space:
mode:
authorEliel C. Sardanons <eliels@gmail.com>2008-11-05 14:37:07 +0000
committerEliel C. Sardanons <eliels@gmail.com>2008-11-05 14:37:07 +0000
commit990a6bebe8a69146b4c7fe8c522d45790190d4e0 (patch)
tree97eea242d5a6caaf848079444598c7800255fdd0 /apps/app_alarmreceiver.c
parentf3d95a2131346e946185734b2743be0afdb519e3 (diff)
Add more SeeAlso references based on TFOT.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@154647 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_alarmreceiver.c')
-rw-r--r--apps/app_alarmreceiver.c14
1 files changed, 10 insertions, 4 deletions
diff --git a/apps/app_alarmreceiver.c b/apps/app_alarmreceiver.c
index 12ae49d65..6b34dfb54 100644
--- a/apps/app_alarmreceiver.c
+++ b/apps/app_alarmreceiver.c
@@ -66,16 +66,22 @@ static char *app = "AlarmReceiver";
/*** DOCUMENTATION
<application name="AlarmReceiver" language="en_US">
<synopsis>
- Provide support for receiving alarm reports from a burglar or fire alarm panel
+ Provide support for receiving alarm reports from a burglar or fire alarm panel.
</synopsis>
<syntax />
<description>
<para>This application should be called whenever there is an alarm panel calling in to dump its events.
- The application will handshake with the alarm panel, and receive events, validate them, handshake them, and store them until the panel hangs up.
- Once the panel hangs up, the application will run the system command specified by the eventcmd setting in <filename>alarmreceiver.conf</filename> and pipe the events to the standard input of the application.
- The configuration file also contains settings for DTMF timing, and for the loudness of the acknowledgement tones.</para>
+ The application will handshake with the alarm panel, and receive events, validate them, handshake them,
+ and store them until the panel hangs up. Once the panel hangs up, the application will run the system
+ command specified by the eventcmd setting in <filename>alarmreceiver.conf</filename> and pipe the
+ events to the standard input of the application.
+ The configuration file also contains settings for DTMF timing, and for the loudness of the
+ acknowledgement tones.</para>
<note><para>Only 1 signalling format is supported at this time: Ademco Contact ID.</para></note>
</description>
+ <see-also>
+ <ref type="filename">alarmreceiver.conf</ref>
+ </see-also>
</application>
***/