manpage: provide usage example, fix typo and switch wrong order of option descriptions
authorMichael Prokop <mika@grml.org>
Thu, 2 Dec 2010 17:49:25 +0000 (18:49 +0100)
committerMichael Prokop <mika@grml.org>
Thu, 2 Dec 2010 17:49:25 +0000 (18:49 +0100)
Closes: issue903

grml-paste.1.txt

index 9925493..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**::
 
@@ -35,11 +35,11 @@ Set your nickname (defaults to login username).
 
   **-s 'server', --server='SERVER'**::
 
-Make private submission to server, thus your paste is not visible on the webpage.
+Set URL of paste server (defaults to paste.grml.org).
 
   **-p, --private**::
 
-Set URL of paste server (defaults to paste.grml.org).
+Make private (hidden) submission to server, thus your paste is not visible on the webpage.
 
   **-v, --verbose**::
 
@@ -80,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].