aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuillermo Ramos2019-06-30 13:46:45 +0200
committerGuillermo Ramos2019-06-30 13:46:45 +0200
commit428615368f7c3c69ad415859162a432cf0866458 (patch)
tree0677b7a5657f155cce38129dd7708216fe830dee
parent95faae2a4d687a189127621faaeecf17a040c3eb (diff)
downloadtgutils-428615368f7c3c69ad415859162a432cf0866458.tar.gz
Add examples to documentation
-rwxr-xr-xtgrecv5
-rwxr-xr-xtgsend5
-rwxr-xr-xtgserver5
3 files changed, 15 insertions, 0 deletions
diff --git a/tgrecv b/tgrecv
index a98820f..bd6e6ad 100755
--- a/tgrecv
+++ b/tgrecv
@@ -126,6 +126,11 @@ I<token>, and outputs it as a JSON array. The array can contain multiple
updates. The connection is blocking (long polling), so it waits until an update
is available before exiting.
+=head1 EXAMPLE
+
+ tgrecv --auto-offset --token 123456789:abcdefghijklmnopqrstuvwxyzABCDEFGHI \
+ | jq .[0].message
+
=head1 AUTHENTICATION
To get the bot token, this program will check (in order):
diff --git a/tgsend b/tgsend
index a889457..0ee318d 100755
--- a/tgsend
+++ b/tgsend
@@ -96,6 +96,11 @@ Show this message
This program will send its standard input to the given Telegram I<chat_ids>, from
the bot identified by I<token>.
+=head1 EXAMPLE
+
+ echo "Hello, word!"
+ | tgsend --token 123456789:abcdefghijklmnopqrstuvwxyzABCDEFGHI 12121212 \
+
=head1 AUTHENTICATION
To get the bot token, this program will check (in order):
diff --git a/tgserver b/tgserver
index 6d1f69d..e624ae2 100755
--- a/tgserver
+++ b/tgserver
@@ -107,6 +107,11 @@ This program waits for Telegram updates from the bot identified by I<token>. For
every update it runs I<prog> with stdin piped to the update, and sending stdout
back as response.
+=head1 EXAMPLE
+
+ tgserver --token 123456789:abcdefghijklmnopqrstuvwxyzABCDEFGHI -- \
+ cowsay -f moofasa
+
=head1 AUTHENTICATION
To get the bot token, this program will check (in order):