From 595d21ff841620a1324a530941d47a0ccc31eaa4 Mon Sep 17 00:00:00 2001 From: "Kay Marquardt (Gnadelwartz)" Date: Mon, 29 Jun 2020 14:55:08 +0200 Subject: [PATCH] update doc --- doc/2_usage.md | 8 +++--- doc/6_reference.md | 17 ++++++++---- examples/README.html | 61 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 78 insertions(+), 8 deletions(-) create mode 100644 examples/README.html diff --git a/doc/2_usage.md b/doc/2_usage.md index 9783a59..bd7af97 100644 --- a/doc/2_usage.md +++ b/doc/2_usage.md @@ -54,7 +54,7 @@ Have FUN! │   ├── bash2env.sh # script to convert shebang to /usr/bin/env, see [Security Considerations](../README.md#Security-Considerations) │   └── bashbot.cron # example crontab │ -├── doc # Documentation and License +├── doc # Documentation and License ├── html ├── LICENSE ├── README.html @@ -184,10 +184,12 @@ e.g. if a new user joins a chat MESSAGE is set to "/_new_chat_user". * ```${LEFTMEMBER[ISBOT]```: Left user is a bot * ```${SERVICE[NEWTITLE]```: Text of new title * ```${MESSAGE}```: /_new_chat_title SENDER TEXT - * ```${SERVICE[NEWPHOTO]```: New Chat Picture URL + * ```${SERVICE[NEWPHOTO]```: New Chat Picture * ```${MESSAGE}```: /_new_chat_picture SENDER URL * ```${SERVICE[PINNED]```: Pinned Message structure * ```${MESSAGE}```: /_new_pinned_message SENDER ID + * ```${PINNED[ID]}```: Id of pinned message + * ```${PINNED[MESSAGE]}```: Message text of pinned message @@ -281,5 +283,5 @@ send_action "${CHAT[ID]}" "action" #### [Prev Create Bot](1_firstbot.md) #### [Next Advanced Usage](3_advanced.md) -#### $$VERSION$$ v0.98-pre2-16-gd24ef50 +#### $$VERSION$$ v0.962-113-g9e3d301 diff --git a/doc/6_reference.md b/doc/6_reference.md index d551aca..2cce77b 100644 --- a/doc/6_reference.md +++ b/doc/6_reference.md @@ -93,14 +93,12 @@ The main use case for send_message is to process the output of interactive chats ---- -### File, Location, Venue, Keyboard +### File, Album, Location, Venue, Keyboard ##### send_file send_file allows you to send different type's of files, e.g. photos, stickers, audio, media, etc. [see more](https://core.telegram.org/bots/api#sending-files) -Starting with version 0.80 send_file implements the following rules: - - file names must not contain ".." - file names must not start with "." - file names not starting with "/" are relative to $TMPDIR, e.g. ./data-bot-bash @@ -109,12 +107,21 @@ Starting with version 0.80 send_file implements the following rules: *usage:* send_file "${CHAT[ID]}" "file" "caption" -*example:* +*example:* ```bash send_file "${CHAT[ID]}" "/home/user/doge.jpg" "Lool" send_file "${CHAT[ID]}" "https://www.domain,com/something.gif" "Something" ``` +##### send_album + +*usage:* send_album "${CHAT[ID]}" "URL1" "URL2" ... "URLn" + +*example:* +```bash +send_album "$(getConfigKey "botadmin")" "http://www.rrr.de/slider/main-image1.jpg" "http://www.rrr.de/slider/main-image5.jpg" +``` + ##### send_location *usage:* send_location "${CHAT[ID]}" "Latitude" "Longitude" @@ -1039,5 +1046,5 @@ The name of your bot is available as bash variable "$ME", there is no need to ca #### [Prev Best Practice](5_practice.md) #### [Next Notes for Developers](7_develop.md) -#### $$VERSION$$ v0.98-pre2-0-ga597303 +#### $$VERSION$$ v0.962-113-g9e3d301 diff --git a/examples/README.html b/examples/README.html new file mode 100644 index 0000000..c9b370a --- /dev/null +++ b/examples/README.html @@ -0,0 +1,61 @@ + + + + + + + Bashobot Documentation - examples/README.html + + + + +
+

Bashobot Documentation - examples/README.html

+
+

Home

+

Bashbot examples

+

bashbot multi

+

An example wrapper to run multiple instances of bashbot, use ./bashbot-multi.sh botname command

+

bashbot.cron

+

An example crontab is provided in examples/bashbot.cron, see Expert use

+

Interactive chats

+

Two examples for interactive scripts are provided as calc.sh and question.sh, see Advanced use

+

Background scripts

+

Background jobs are an easy way to provide sceduled messages or alerts if something happens. notify.sh is a simple example on how to send a message every x seonds, e.g. current time.

+

background-scripts contains a more useful example on how to start and stop different scripts plus some example background scripts.

+
    mycommands.sh - /run_xxx and /kill-xxx will start any script named run_xxx.sh
+
+    run_diskusage.sh - shows disk usage every 100 seconds
+    run_filename.sh - shown the name of new files in a named dir
+    run_filecontent.sh  - shown the content of new files in a named dir
+    run_notify.sh - same as notify.sh
+
+

Note: Output of system commands often contains newlines, each newline results in a telegram message, the function 'send_telegram' in mycommands.sh avoids this by converting each newline to ' mynewlinestartshere ' before output the string.

+

System Status

+

send-system-status contains an example for commands showing status of different subsystems. This example is adapted from https://github.com/RG72/telegram-bot-bash to current bashbot commands, but not fully tested. This will show how easy you can convert existing bots.

+
    mycommands.sh - commands to show system status
+    botacl - controls who can show system status
+
+*Available commands*:
+    /se *sensors*
+    /smb *smbstatus*
+    /free *memory status*
+    /md *raid status*
+    /lvm *lvm status*
+    /lvsd *Datailed lvm status*
+    /df *disk space*
+    /ifconfig *ifconfig output*
+    /smart *sda* _smart status for sda drive_
+
+

External scripts

+

external-use will contain some examples on how to send messages from external scripts to Telegram chats or users.

+

$$VERSION$$ v0.98-pre2-0-ga597303

+ +