Review Board 1.7.16


Add a manpage for the smsq application

Review Request #3895 - Created Aug. 7, 2014 and submitted

Jeremy Lainé
ASTERISK-24170
Reviewers
asterisk-dev
Asterisk
This patch adds a manpage for the smsq application. The options were automatically extracted using help2man.

 

Diff revision 2 (Latest)

1 2
1 2

  1. /trunk/doc/smsq.8: Loading...
/trunk/doc/smsq.8
New File

    
   
1
.TH SMSQ "8" "May 2014" "Asterisk trunk" ""

    
   
2
.SH NAME

    
   
3
smsq \- helper to send SMS messages

    
   
4
.SH SYNOPSIS

    
   
5
.B smsq

    
   
6
\fI\,<oa/da> <message>\/\fR

    
   
7
.SH DESCRIPTION

    
   
8
smsq is a simple helper application designed to make it easy to send messages

    
   
9
from a command line. it is intended to run on the Asterisk box and have direct

    
   
10
access to the queue directories for SMS and for Asterisk.

    
   
11
.SH OPTIONS

    
   
12
.TP

    
   
13
\fB\-q\fR, \fB\-\-queue\fR=\fI\,number[\-X]\/\fR

    
   
14
Queue [inc sub address] (default: "")

    
   
15
.TP

    
   
16
\fB\-d\fR, \fB\-\-da\fR=\fI\,number\/\fR

    
   
17
Destination address

    
   
18
.TP

    
   
19
\fB\-o\fR, \fB\-\-oa\fR=\fI\,number\/\fR

    
   
20
Origination address

    
   
21
.TP

    
   
22
\fB\-m\fR, \fB\-\-ud\fR=\fI\,text\/\fR

    
   
23
Message

    
   
24
.TP

    
   
25
\fB\-f\fR, \fB\-\-ud\-file\fR=\fI\,filename\/\fR

    
   
26
Message file

    
   
27
.TP

    
   
28
\fB\-\-UTF\-8\fR

    
   
29
File treated as null terminated UTF\-8

    
   
30
(default)

    
   
31
.TP

    
   
32
\fB\-\-UCS\-1\fR

    
   
33
File treated as UCS\-1

    
   
34
.TP

    
   
35
\fB\-\-UCS\-2\fR

    
   
36
File treated as UCS\-2

    
   
37
.TP

    
   
38
\fB\-t\fR, \fB\-\-mt\fR

    
   
39
Mobile Terminated

    
   
40
.TP

    
   
41
\fB\-\-mo\fR

    
   
42
Mobile Originated

    
   
43
.TP

    
   
44
\fB\-\-tx\fR

    
   
45
Send message

    
   
46
.TP

    
   
47
\fB\-r\fR, \fB\-\-rx\fR

    
   
48
Queue for receipt

    
   
49
.TP

    
   
50
\fB\-e\fR, \fB\-\-process\fR=\fI\,command\/\fR

    
   
51
Rx queue process command

    
   
52
.TP

    
   
53
\fB\-x\fR, \fB\-\-no\-dial\fR

    
   
54
Do not dial

    
   
55
.TP

    
   
56
\fB\-\-no\-wait\fR

    
   
57
Do not wait if already calling

    
   
58
.TP

    
   
59
\fB\-\-concurrent\fR=\fI\,n\/\fR

    
   
60
Number of concurrent calls to allow

    
   
61
(default: 1)

    
   
62
.TP

    
   
63
\fB\-\-motx\-channel\fR=\fI\,channel\/\fR

    
   
64
Channel for motx calls (default:

    
   
65
"Local/1709400X")

    
   
66
.TP

    
   
67
\fB\-\-motx\-callerid\fR=\fI\,number\/\fR

    
   
68
Caller ID for motx calls (default is

    
   
69
queue name without sub address)

    
   
70
.TP

    
   
71
\fB\-\-motx\-wait\fR=\fI\,seconds\/\fR

    
   
72
Time to wait for motx call to answer

    
   
73
(default: 10)

    
   
74
.TP

    
   
75
\fB\-\-motx\-delay\fR=\fI\,seconds\/\fR

    
   
76
Time between motx call retries (default:

    
   
77
1)

    
   
78
.TP

    
   
79
\fB\-\-motx\-retries\fR=\fI\,n\/\fR

    
   
80
Number of retries for motx call (default:

    
   
81
10)

    
   
82
.TP

    
   
83
\fB\-\-mttx\-channel\fR=\fI\,channel\/\fR

    
   
84
Channel for mttx calls (default is Local/

    
   
85
and queue name without sub address)

    
   
86
.TP

    
   
87
\fB\-\-mttx\-callerid\fR=\fI\,number\/\fR

    
   
88
Caller ID for mttx calls (default is

    
   
89
queue name without sub address) (default:

    
   
90
"080058752X0")

    
   
91
.TP

    
   
92
\fB\-\-mttx\-wait\fR=\fI\,seconds\/\fR

    
   
93
Time to wait for mttx call to answer

    
   
94
(default: 10)

    
   
95
.TP

    
   
96
\fB\-\-mttx\-delay\fR=\fI\,seconds\/\fR

    
   
97
Time between mttx call retries (default:

    
   
98
30)

    
   
99
.TP

    
   
100
\fB\-\-mttx\-retries\fR=\fI\,n\/\fR

    
   
101
Number of retries for mttx call (default:

    
   
102
100)

    
   
103
.TP

    
   
104
\fB\-n\fR, \fB\-\-mr\fR=\fI\,n\/\fR

    
   
105
Message reference

    
   
106
.TP

    
   
107
\fB\-p\fR, \fB\-\-pid\fR=\fI\,n\/\fR

    
   
108
Protocol ID

    
   
109
.TP

    
   
110
\fB\-c\fR, \fB\-\-dcs\fR=\fI\,n\/\fR

    
   
111
Data Coding Scheme

    
   
112
.TP

    
   
113
\fB\-\-udh\fR=\fI\,hex\/\fR

    
   
114
User data header

    
   
115
.TP

    
   
116
\fB\-\-srr\fR

    
   
117
Status Report Request

    
   
118
.TP

    
   
119
\fB\-\-rp\fR

    
   
120
Return Path request

    
   
121
.TP

    
   
122
\fB\-\-v\fR=\fI\,seconds\/\fR

    
   
123
Validity Period

    
   
124
.TP

    
   
125
\fB\-\-scts\fR=\fI\,YYYY\-MM\-SSTHH\/\fR:MM:SS

    
   
126
Timestamp

    
   
127
.TP

    
   
128
\fB\-\-default\-sub\-address\fR=\fI\,X\/\fR

    
   
129
Default sub address (default: "9")

    
   
130
.TP

    
   
131
\fB\-\-spool\-dir\fR=\fI\,dirname\/\fR

    
   
132
Asterisk spool dir (default:

    
   
133
"/var/spool/asterisk")

    
   
134
.SS "Help options:"

    
   
135
.TP

    
   
136
\-?, \fB\-\-help\fR

    
   
137
Show this help message

    
   
138
.TP

    
   
139
\fB\-\-usage\fR

    
   
140
Display brief usage message

    
   
141

   

    
   
142
.SH SEE ALSO

    
   
143
.B asterisk(8)

    
   
144

   

    
   
145
.SH AUTHOR

    
   
146
This manual page was written by Jeremy Lainé <jeremy.laine@m4x.org>.
  1. /trunk/doc/smsq.8: Loading...

https://reviewboard.asterisk.org/ runs on a server provided by Digium, Inc. and uses bandwidth donated to the open source Asterisk community by API Digital Communications in Huntsville, AL USA.
Please report problems with this site to asteriskteam@digium.com.