manpage: provide usage example, fix typo and switch wrong order of option descriptions
[grml-paste.git] / grml-paste.1.txt
index aeaf588..9026164 100644 (file)
@@ -19,7 +19,7 @@ Options
 
   **-e 'hours', --expire='HOURS'**::
 
-Time at wich paste should expire.
+Time at which paste should expire.
 
   **-h, --help**::
 
@@ -31,12 +31,16 @@ Type of language to highlight.
 
   **-n 'name', --name='NAME'**::
 
-Set your nickname (defaults to anonymous).
+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.
@@ -48,7 +52,7 @@ Actions
 
 Add paste to the server: <1.line> <2.line> ...
 
-  **del '<digest>'*::
+  **del '<digest>'**::
 
 Delete paste from server.
 
@@ -56,6 +60,18 @@ Delete paste from server.
 
 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.
@@ -64,6 +80,17 @@ Get supported language highlighting types from server.
 
 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 the grml team].