| 1 | $Id$ |
|---|
| 2 | |
|---|
| 3 | DESCRIPTION |
|---|
| 4 | There is a file called licq_fifo in the base directory, typically |
|---|
| 5 | ~/.licq. This is a special device called a FIFO |
|---|
| 6 | (for First-In-First-Out). You can write to this file just like |
|---|
| 7 | any other file, although typically one uses |
|---|
| 8 | echo something > licq_fifo. |
|---|
| 9 | |
|---|
| 10 | QUOTING |
|---|
| 11 | The <"> is used for quoting. |
|---|
| 12 | Escape Sequences: (only valid in a quoted string) |
|---|
| 13 | \n NL |
|---|
| 14 | \t h tab |
|---|
| 15 | \v v tab |
|---|
| 16 | \b backspace (?) |
|---|
| 17 | \r CR |
|---|
| 18 | \f FF |
|---|
| 19 | \a BEL |
|---|
| 20 | |
|---|
| 21 | Be careful of shell special characters like '"[],; etc. Escape these |
|---|
| 22 | characters with a "\". |
|---|
| 23 | |
|---|
| 24 | FIFO COMMANDS |
|---|
| 25 | <> is the "meta delimiter" (so don't type it) |
|---|
| 26 | [] arguments are optional |
|---|
| 27 | |
|---|
| 28 | help <command> |
|---|
| 29 | print commands help information. |
|---|
| 30 | |
|---|
| 31 | status <[*]<status>> <auto response> |
|---|
| 32 | status: online, offline, na, away, occupied, dnd, ffc |
|---|
| 33 | Sets the status of the current licq session to that given |
|---|
| 34 | (precede the the status by a "*" for invisible mode) |
|---|
| 35 | |
|---|
| 36 | auto_response <auto response> |
|---|
| 37 | Sets the auto response message without changing the current |
|---|
| 38 | status. |
|---|
| 39 | |
|---|
| 40 | message <buddy> <message> |
|---|
| 41 | Send a message to the given buddy. |
|---|
| 42 | |
|---|
| 43 | url <buddy> <url> [<description>] |
|---|
| 44 | Send a url to the given buddy. |
|---|
| 45 | |
|---|
| 46 | sms <buddy> <message> |
|---|
| 47 | Send a SMS to the given buddy. |
|---|
| 48 | |
|---|
| 49 | sms-number <number> <message> |
|---|
| 50 | Send a SMS to the given cellular number. |
|---|
| 51 | |
|---|
| 52 | redirect <file> |
|---|
| 53 | Redirects the stdout and stderr for licq to the given file |
|---|
| 54 | |
|---|
| 55 | debuglvl <level> |
|---|
| 56 | Set what information is logged. |
|---|
| 57 | See <level> in licq -h. |
|---|
| 58 | |
|---|
| 59 | adduser <buddy> |
|---|
| 60 | Add a user to your contact list. note that buddy must be an uin |
|---|
| 61 | |
|---|
| 62 | userinfo <buddy> |
|---|
| 63 | Updates a buddy's user information |
|---|
| 64 | |
|---|
| 65 | exit |
|---|
| 66 | Causes the licq session to shutdown. |
|---|
| 67 | |
|---|
| 68 | ui_viewevent [<buddy>] |
|---|
| 69 | Shows the oldest pending event. |
|---|
| 70 | |
|---|
| 71 | ui_message <buddy> |
|---|
| 72 | Open the plugin's message composer to <buddy>. |
|---|
| 73 | |
|---|
| 74 | list_plugins |
|---|
| 75 | Lists the loaded UI plugins. |
|---|
| 76 | |
|---|
| 77 | load_plugin <plugin> |
|---|
| 78 | Loads the UI plugin called <plugin>. |
|---|
| 79 | |
|---|
| 80 | unload_plugin <plugin> |
|---|
| 81 | Unloads the UI plugin called <plugin>. |
|---|
| 82 | Use list_plugins to see currently loaded UI plugins. |
|---|
| 83 | |
|---|
| 84 | help <command> |
|---|
| 85 | print commands help information. |
|---|
| 86 | |
|---|
| 87 | EXAMPLES |
|---|
| 88 | $ LICQ_FIFO="$HOME/.licq/licq_fifo" |
|---|
| 89 | # change the status. set an away message |
|---|
| 90 | $ echo 'status *away "%a: Im away?"' > $LICQ_FIFO |
|---|
| 91 | # send a message to John |
|---|
| 92 | $ echo 'message John "\t H e l l o\n world"' > $LICQ_FIFO |
|---|
| 93 | # send a message to 1234567 |
|---|
| 94 | $ echo 'message 1234567 "you are a lucky man"' > $LICQ_FIFO |
|---|
| 95 | # send an URL to message to Bob |
|---|
| 96 | $ echo 'url Bob http://www.licq.org "do you use it?" ' |
|---|
| 97 | # close licq |
|---|
| 98 | $ echo 'exit' > $LICQ_FIFO |
|---|
| 99 | |
|---|
