octoleo/telegram-bot-bash
1
1
Fork 0
mirror of https://github.com/octoleo/telegram-bot-bash.git synced 2025-02-10 14:18:29 +00:00
Code Issues Projects Releases Wiki Activity

update doc for loggin

Browse Source
This commit is contained in:
Kay Marquardt (Gnadelwartz) 2020-06-18 16:20:42 +02:00
parent ba614b71fd
commit 9adc62d6ec
4 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.html
View File

@ -176,14 +176,14 @@ It features background tasks and interactive chats, and can serve as an interfac
</code></pre> </code></pre>
<p>For more Information on how to install, customize and use your new bot, read the <a href="#Documentation">Documentation</a></p> <p>For more Information on how to install, customize and use your new bot, read the <a href="#Documentation">Documentation</a></p>
<h3>Log files</h3> <h3>Log files</h3>
<p>Since version 0.96 bashbot log commands recieved (updates) and connection errors. If you start bashbot in debug mode bash stdout, stderr and all recieved telegram message updates are logged also.</p> <p>Since version 0.96 bashbot log commands recieved/send and connection errors. If you start bashbot in debug mode bash stdout, stderr and all send/received telegram message are logged also.</p>
<p>To enable debug mode start bashbot with debug as third argument: <code>bashbot start debug</code></p> <p>To enable debug mode start bashbot with debug as third argument: <code>bashbot start debug</code></p>
<pre><code>├── logs <pre><code>├── logs
│   ├── BASHBOT.log # log what your bot is doing ...
│   ├── ERROR.log # connection errors from / to telegram API │   ├── ERROR.log # connection errors from / to telegram API
│   ├── UPDATE.log # summary whats received from your bot
│   │ │   │
│   ├── DEBUG.log # stdout/stderr of you bot (debug mode enabled) │   ├── DEBUG.log # stdout/stderr of you bot (debug mode enabled)
│   └── MESSAGE.log # full text of all message updates received (debug mode enabled) │   └── MESSAGE.log # full text of all message send/received (debug mode enabled)
</code></pre> </code></pre>
<hr /> <hr />
<h2>Security Considerations</h2> <h2>Security Considerations</h2>
@ -257,6 +257,6 @@ It features background tasks and interactive chats, and can serve as an interfac
<p>@Gnadelwartz</p> <p>@Gnadelwartz</p>
<h2>That's it!</h2> <h2>That's it!</h2>
<p>If you feel that there's something missing or if you found a bug, feel free to submit a pull request!</p> <p>If you feel that there's something missing or if you found a bug, feel free to submit a pull request!</p>
<h4>$$VERSION$$ v0.98-dev-42-geea1de6</h4> <h4>$$VERSION$$ v0.98-dev-47-gba614b7</h4>
</body> </body>
</html> </html>

10
README.md
View File

@ -104,18 +104,18 @@ For more Information on how to install, customize and use your new bot, read the
### Log files ### Log files
Since version 0.96 bashbot log commands recieved (updates) and connection errors. If you start bashbot in debug mode Since version 0.96 bashbot log commands recieved/send and connection errors. If you start bashbot in debug mode
bash stdout, stderr and all recieved telegram message updates are logged also. bash stdout, stderr and all send/received telegram message are logged also.
To enable debug mode start bashbot with debug as third argument: `bashbot start debug` To enable debug mode start bashbot with debug as third argument: `bashbot start debug`
``` ```
├── logs ├── logs
│   ├── BASHBOT.log # log what your bot is doing ...
│   ├── ERROR.log # connection errors from / to telegram API │   ├── ERROR.log # connection errors from / to telegram API
│   ├── UPDATE.log # summary whats received from your bot
│   │ │   │
│   ├── DEBUG.log # stdout/stderr of you bot (debug mode enabled) │   ├── DEBUG.log # stdout/stderr of you bot (debug mode enabled)
│   └── MESSAGE.log # full text of all message updates received (debug mode enabled) │   └── MESSAGE.log # full text of all message send/received (debug mode enabled)
``` ```
---- ----
@ -239,4 +239,4 @@ This may happen if to many wrong requests are sent to api.telegram.org, e.g. usi
If you feel that there's something missing or if you found a bug, feel free to submit a pull request! If you feel that there's something missing or if you found a bug, feel free to submit a pull request!
#### $$VERSION$$ v0.98-dev-42-geea1de6 #### $$VERSION$$ v0.98-dev-47-gba614b7

14
README.txt
View File

@ -133,21 +133,21 @@ the [Documentation](#Documentation)
### Log files ### Log files
Since version 0.96 bashbot log commands recieved (updates) and connection Since version 0.96 bashbot log commands recieved/send and connection errors. If
errors. If you start bashbot in debug mode you start bashbot in debug mode
bash stdout, stderr and all recieved telegram message updates are logged also. bash stdout, stderr and all send/received telegram message are logged also.
To enable debug mode start bashbot with debug as third argument: `bashbot start To enable debug mode start bashbot with debug as third argument: `bashbot start
debug` debug`
``` ```
├── logs ├── logs
│   ├── BASHBOT.log # log what your bot is doing ...
│   ├── ERROR.log # connection errors from / to telegram API │   ├── ERROR.log # connection errors from / to telegram API
│   ├── UPDATE.log # summary whats received from your bot
│   │ │   │
│   ├── DEBUG.log # stdout/stderr of you bot (debug mode enabled) │   ├── DEBUG.log # stdout/stderr of you bot (debug mode enabled)
│   └── MESSAGE.log # full text of all message updates received (debug │   └── MESSAGE.log # full text of all message send/received (debug mode
mode enabled) enabled)
``` ```
---- ----
@ -328,4 +328,4 @@ in 'mycommands.sh' as example.
If you feel that there's something missing or if you found a bug, feel free to If you feel that there's something missing or if you found a bug, feel free to
submit a pull request! submit a pull request!
#### $$VERSION$$ v0.98-dev-42-geea1de6 #### $$VERSION$$ v0.98-dev-47-gba614b7

4
doc/2_usage.md
View File

@ -32,7 +32,7 @@ Have FUN!
├── scripts # place your bashbot interactive and background scripts here ├── scripts # place your bashbot interactive and background scripts here
│   └── interactive.sh.clean # interactive script template for new scripts │   └── interactive.sh.clean # interactive script template for new scripts
│ │
├── logs # here you'll find ERROR, UPDATE, DEBUG and MESSAGE.log ├── logs # here you'll find BASHBOT, ERROR, DEBUG and MESSAGE.log
│ │
├── modules # optional functions, sourced by commands.sh ├── modules # optional functions, sourced by commands.sh
│   ├── aliases.sh # to disable modules rename them xxx.sh.off │   ├── aliases.sh # to disable modules rename them xxx.sh.off
@ -281,5 +281,5 @@ send_action "${CHAT[ID]}" "action"
#### [Prev Create Bot](1_firstbot.md) #### [Prev Create Bot](1_firstbot.md)
#### [Next Advanced Usage](3_advanced.md) #### [Next Advanced Usage](3_advanced.md)
#### $$VERSION$$ v0.98-dev-32-g6e3655f #### $$VERSION$$ v0.98-dev-47-gba614b7