annotate paster.1.in @ 19:3aef43b40f1c

make: improve user modifications
author David Demelier <markand@malikania.fr>
date Thu, 06 Feb 2020 20:10:00 +0100
parents a5035bcbf7a8
children 511e2e865e15
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .\" Copyright (c) 2020 David Demelier <markand@malikania.fr>
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Permission to use, copy, modify, and/or distribute this software for any
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\" purpose with or without fee is hereby granted, provided that the above
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" copyright notice and this permission notice appear in all copies.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\"
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\"
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .Dd 06 February, 2020
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Dt PASTER 1
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Os
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .\" NAME
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Sh NAME
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .Nm paster
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Nd simple paste service client
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .\" SYNOPSIS
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh SYNOPSIS
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 .Nm
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Op Fl LDvx
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .Op Fl a Ar author
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .Op Fl l Ar language
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .Op Fl d Ar duration
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 .Op Fl t Ar title
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 .Ar filename
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 .Ar host
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .\" DESCRIPTION
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 .Sh DESCRIPTION
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 The
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 .Nm
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 tool is the convenient brother to
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 .Nm pasterd ,
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 it will paste some content into an instance.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .Pp
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 The
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 .Ar filename
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 argument can points to a file whose content will be pasted, if it is set to
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 .Dq -
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 then standard input is read instead.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 .Pp
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 The
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 .Ar host
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 argument is a URL where a
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 .Nm pasterd
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 instance is running.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 .Pp
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 Available options:
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 .Bl -tag -width Ds
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 .It Fl L
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 List all supported languages.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 .It Fl D
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 List all supported durations.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 .It Fl v
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 Be more verbose.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 .It Fl x
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 Store the paste as private.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 .It Fl a Ar author
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 Sets the author, defaults to
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .Dq Anonymous .
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 .It Fl l Ar language
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 Sets the code snippet language, defaults to
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 .Dq "nohighlight" .
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 .It Fl d Ar duration
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 Sets the paste lifetime, defaults to
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 .Dq "month" .
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 .It Fl t Ar title
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 Sets a title to the paste, defaults to
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 .Dq "Untitled" .
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 .\" EXAMPLES
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 .Sh EXAMPLES
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 .Ss Paste the main.sh script shell with a title and an author.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 .Bd -literal -offset
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 paster -t "Some shell script" -a Francis -l shell main.sh http://example.org
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 .Ed
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 .Ss Read standard input and paste it.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 .Bd -literal -offset
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 grep error logs.txt | paster - http://example.org
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 .Ed
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 .Ss Paste a non-listed file with a short duration.
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 .Bd -literal -offset
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 paste -x -d hour private.txt http://example.org
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 .Ed
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 .\" SEE ALSO
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 .Sh SEE ALSO
a5035bcbf7a8 doc: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 .Xr pasterd 8