index.md

changeset 0
80a2cf045e6a
child 1
acfb872c93a1
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/index.md	Fri Feb 07 14:38:00 2020 +0100
@@ -0,0 +1,71 @@
+% paster - simple paste service
+% David Demelier <markand@malikania.fr>
+% 2020-02-07
+
+paster - simple paste service
+=============================
+
+<i class="fas fa-file-alt" style="font-size: 400%"></i>
+
+Paster is a minimalist paste service written in C18 using [kcgi][] and
+[sqlite][].
+
+It also comes with a convenient shell script to paste directly from command
+line.
+
+**Note: it is currently in beta stage but you may already try it.**
+
+Download
+--------
+
+- [paster-0.1.0.tar.xz][] ([signature][paster-0.1.0.tar.xz.asc])
+
+Installation
+------------
+
+Usually, the following steps are enough:
+
+	make
+	make install
+
+More options are available, see [INSTALL.md][] in source package for more
+information.
+
+Documentation
+-------------
+
+See available manual pages:
+
+- [pasterd.8][] ([pdf][pasterd.8.pdf])
+- [pasterd-clean.8][] ([pdf][pasterd-clean.8.pdf])
+- [paster.1][] ([pdf][paster.1.pdf])
+
+Usage
+-----
+
+### Web application usage
+
+Please check the dedicated [pasterd.8][] manual page for installation into your
+web server.
+
+### Client usage
+
+If you want to paste directly from command line, you can use the `paster` tool.
+
+Example, pasting a shell file:
+
+	paster -l shell foo.sh http://example.org
+
+Use **-** instead of a filename to paste from standard input.
+
+[INSTALL.md]: http://hg.malikania.fr/paster/file/34da05319353/INSTALL.md
+[kcgi]: https://kristaps.bsd.lv/kcgi
+[paster-0.1.0.tar.xz.asc]: http://releases.malikania.fr/paster/0.1.0/paster-0.1.0.tar.xz.asc
+[paster-0.1.0.tar.xz]: http://releases.malikania.fr/paster/0.1.0/paster-0.1.0.tar.xz
+[paster.1.pdf]: paster.pdf
+[paster.1]: paster.html
+[pasterd-clean.8.pdf]: pasterd-clean.pdf
+[pasterd-clean.8]: pasterd-clean.html
+[pasterd.8.pdf]: pasterd.pdf
+[pasterd.8]: pasterd.html
+[sqlite]: http://sqlite.org

mercurial