Release new version 0.8
[grml-paste.git] / grml-paste.1.txt
1 grml-paste(1)
2 =============
3
4 Name
5 ----
6 grml-paste - command line interface for paste.grml.org
7
8 Synopsis
9 --------
10 grml-paste [options] ACTION <args>
11
12 Description
13 -----------
14
15 grml-paste is a command line interface for uploading plain text to https://paste.grml.org/
16
17 Options
18 -------
19
20   **-e 'hours', --expire='HOURS'**::
21
22 Time at which paste should expire.
23
24   **-h, --help**::
25
26 Print help text.
27
28   **-l 'lang', --lang='LANG'**::
29
30 Type of language to highlight.
31
32   **-n 'name', --name='NAME'**::
33
34 Set your nickname (defaults to login username).
35
36   **-s 'server', --server='SERVER'**::
37
38 Set URL of paste server (defaults to paste.grml.org).
39
40   **-p, --private**::
41
42 Make private (hidden) submission to server, thus your paste is not visible on the webpage.
43
44   **-v, --verbose**::
45
46 More verbose output.
47
48 Actions
49 -------
50
51   **add**::
52
53 Add paste to the server: <1.line> <2.line> ...
54
55   **del '<digest>'**::
56
57 Delete paste from server.
58
59  **get '<id>'**::
60
61 Get paste from server.
62
63  **addurl '<url>'**::
64
65 Add short-URL.
66
67  **geturl '<url>'**::
68
69 Resolve short-URL.
70
71  **getclicks '<url>'**::
72
73 Get clicks of short-URL.
74
75   **getlangs**::
76
77 Get supported language highlighting types from server.
78
79   **help <action>**::
80
81 Print more verbose help about specified '<action>'.
82
83 Usage examples
84 --------------
85
86   **dmesg | tail | grml-paste add --name=grmluser**::
87
88 Upload last ten lines of dmesg output as user 'grmluser'.
89
90   **grep -e EE -e WW /var/log/Xorg.0.log | grml-paste add -p**::
91
92 Upload error and warning messages of X.org log as hidden entry.
93
94 Bugs
95 ----
96 Please report feedback, link:https://grml.org/bugs/[bugreports] and wishes link:https://grml.org/contact/[to the grml team].
97
98 Authors
99 -------
100 Michael Gebetsroither <gebi@grml.org>