Release new version 0.8

[grml-paste.git] / grml-paste.1.txt

diff --git a/grml-paste.1.txt b/grml-paste.1.txt
index 4d5d960..c9bd9ff 100644 (file)
--- a/grml-paste.1.txt
+++ b/grml-paste.1.txt
@@ -7,36 +7,94 @@ grml-paste - command line interface for paste.grml.org
 
 Synopsis
 --------
-grml-paste [-n nick] [-s summary] [-f source] [-h|--help]
+grml-paste [options] ACTION <args>
 
 Description
 -----------
 
-grml-paste is a command line interface for uploading plain text to http://paste.grml.org/
+grml-paste is a command line interface for uploading plain text to https://paste.grml.org/
 
 Options
 -------
 
-  -n **nick**::
+  **-e 'hours', --expire='HOURS'**::
 
-Set your nickname (defaults to Anonymous).
+Time at which paste should expire.
 
-  -s **summary**::
+  **-h, --help**::
 
-Specify a summary of your paste (defaults to none).
+Print help text.
 
-  -f **source**::
+  **-l 'lang', --lang='LANG'**::
 
-Sets the file to read from, use - to read from stdin.
+Type of language to highlight.
 
-  --help::
+  **-n 'name', --name='NAME'**::
 
-Print help text.
+Set your nickname (defaults to login username).
+
+  **-s 'server', --server='SERVER'**::
+
+Set URL of paste server (defaults to paste.grml.org).
+
+  **-p, --private**::
+
+Make private (hidden) submission to server, thus your paste is not visible on the webpage.
+
+  **-v, --verbose**::
+
+More verbose output.
+
+Actions
+-------
+
+  **add**::
+
+Add paste to the server: <1.line> <2.line> ...
+
+  **del '<digest>'**::
+
+Delete paste from server.
+
+ **get '<id>'**::
+
+Get paste from server.
+
+ **addurl '<url>'**::
+
+Add short-URL.
+
+ **geturl '<url>'**::
+
+Resolve short-URL.
+
+ **getclicks '<url>'**::
+
+Get clicks of short-URL.
+
+  **getlangs**::
+
+Get supported language highlighting types from server.
+
+  **help <action>**::
+
+Print more verbose help about specified '<action>'.
+
+Usage examples
+--------------
+
+  **dmesg | tail | grml-paste add --name=grmluser**::
+
+Upload last ten lines of dmesg output as user 'grmluser'.
+
+  **grep -e EE -e WW /var/log/Xorg.0.log | grml-paste add -p**::
+
+Upload error and warning messages of X.org log as hidden entry.
 
 Bugs
 ----
-Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes link:http://grml.org/contact/[to us]!
+Please report feedback, link:https://grml.org/bugs/[bugreports] and wishes link:https://grml.org/contact/[to the grml team].
 
 Authors
 -------
-Nico Golde <nico@grml.org>
+Michael Gebetsroither <gebi@grml.org>