Texinfo documentation, website and asciicasts

[paster.git] / doc / examples.texi

diff --git a/doc/examples.texi b/doc/examples.texi
new file mode 100644 (file)
index 0000000..1de5e34
--- /dev/null
+++ b/doc/examples.texi
@@ -0,0 +1,55 @@
+@node Examples
+@unnumbered Examples
+
+With @command{contrib/paster} you can send the paste very easily:
+
+@itemize
+
+@item
+@example
+$ paster
+something I want to send
+whatever whenever
+^D
+http://paster.example.com/4KEOLWCZY5CBVWDNT5TA.txt
+SHA512/2: 28d95ef0e8d6a4f4222d0e7eb2a23777aa99efb0794e535a0f4a55490705438f
+@end example
+
+@item With overriden file extension
+@example
+$ paster webp < some-image.webp
+http://paster.example.com/KO5O7SJTUGBORVGOZBSA.webp
+SHA512/2: 7f53424fe50f1d70fa32763cde31335dc82fd63c975e8ab95f0bb4a6cd94fb1c
+@end example
+
+@item With file extension taken from the specified path. Daemon is run
+    with multiple URLs specified.
+
+@example
+$ paster some-other-image.webp
+http://paster.example.com/O6D2O3N5HPH63ZFIYF4A.webp
+https://paster.example.com/O6D2O3N5HPH63ZFIYF4A.webp
+ftp://paster.example.com/pub/pastes/O6D2O3N5HPH63ZFIYF4A.webp
+SHA512/2: 2ffe10846ec637d29ab9145b98c3699653c01910bb6d9e00e41f7fe02c5882a8
+@end example
+
+@item
+@example
+$ grep whatever ... | paster
+$ import png:- | paster png
+$ import -define webp:lossless=true webp:- | paster webp
+$ echo http://example.com | paster url
+$ paster < /proc/cpuinfo
+@end example
+
+@item Pasting the @url{https://asciinema.org/, asciicast} requires
+@file{.cast} extension. @file{.cast.html} URLs will appear.
+
+@example
+$ paster path/to/ascii.cast
+http://paster.example.com/ST4LOKGUISMACAAFC4CA.cast
+SHA512/2: 171e39f35b58b39f0bc2f3def59955d6573756374584d5443afa16d31032fdf3
+http://paster.example.com/ST4LOKGUISMACAAFC4CA.cast.html
+@end example
+
+@end itemize