SMS Gateway 4.4 - User's Guide

Table of ContentsPreviousNextIndex

11. Command reference

Here we describe the syntax of each command in the software. You can use -v as an option for most of the commands to get syntax information for the command. To get debug information, especially good for smsd, use the -debug option.

11.1 Commands

11.1.1 sms

Place a message in queue

Parameters:

-v Display software version and command syntax
- Read data from stdin
-id Display the id of the message after it has been placed in the outgoing queue
-l file Read recipients from the specified file
-n string Add a note to the message. Displayed in the message queues
-t hh:mm Schedule the message for transmission at a specific time
-c id Specify a character set to use for the message
-s id Specify a symbol set to use for the message
-q Do not send messages to stdout (quiet)
-u username Send the message as the specified user

11.1.2 smsclean

Remove entries from the statistics

Parameters:

-v Display software version and command syntax
-older days Remove entries older than specified number of days
-to date Remove entries until specified date

11.1.3 smsd

The SMS Gateway daemon

Parameters:

-v Display software version and command syntax
-debug Print debug information to stdout
-gateways Display defined gateways

11.1.4 smsmime

Parses MIME messages

Parameters:

-v Display software version and command syntax

11.1.5 smsq

Display the message queues

Parameters:

-v Display software version and command syntax
-p Display the outgoing message queue (default)
-s Display the message queue for successfully sent messages
-f Display the message queue for failed messages
-n id Reschedule the message for transmission now
-reverse Display the queue in reversed order (last message first)
-t hh:mm id Reschedule the message for transmission at the specified time
-x Display extra information about the messages

11.1.6 smsrm

Remove a message from a queue

When used with the successfully sent or failed queues, the entries are not physically removed from the statistics file, they are only marked as deleted. Smsclean is used to delete entries permanently from the statistics file.

Parameters:

-v Display software version and command syntax
-all [p|s|f] Remove all messages in the specified queue(s)
-to yyyymmdd Remove all messages until the specified date

11.1.7 smsstat

Display message statistics (per gateway)

Parameters:

-v Display software version and command syntax
-g Show graph

11.1.8 smswho

Display users connected to smsd

Parameters:

-v Display software version and command syntax
-u Only display unique user names

11.2 Exit codes

The client programs use the following exit codes:

2 Error in serialisation file

3 Error in configuration file

4 Invalid argument

6 Could not connect to smsd

13 Invalid recipient

16 Could not read recipients file

52 Out of disk space

Table of ContentsPreviousNextIndex