docs/honk.5 (view raw)
1.\"
2.\" Copyright (c) 2019 Ted Unangst
3.\"
4.\" Permission to use, copy, modify, and distribute this software for any
5.\" purpose with or without fee is hereby granted, provided that the above
6.\" copyright notice and this permission notice appear in all copies.
7.\"
8.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15.\"
16.Dd $Mdocdate$
17.Dt HONK 5
18.Os
19.Sh NAME
20.Nm honk
21.Nd status composition
22.Sh DESCRIPTION
23Status updates composed in
24.Nm
25have many features beyond just plain text.
26.Pp
27The process begins by pressing the button marked
28.Dq it's honking time
29to activate the honk form.
30.Pp
31A subset of markdown is supported.
32.Bl -tag -width tenletters
33.It bold
34**bold text**
35.It italics
36*italicized text*
37.It quotes
38> This text is quoted.
39.It code
40Inline `code fragments` with single ticks.
41.Bd -literal
42```
43Large code blocks
44with triple ticks.
45```
46.Ed
47.It links
48URLs beginning with
49.Dq http
50or
51.Dq https
52will be autolinked.
53.El
54.Pp
55Mentioning a specfic user such as
56.Pq @user@example.social
57will send a copy of the message to them.
58When honking back, the author of the parent post is automatically mentioned.
59.Pp
60Threads from the tiny bird site may be included as quotes in a post via the
61.Ar hoot
62operator followed by the URL.
63.Dl hoot: https://twitter.com/tedunangst/status/835172824734175234
64.Pp
65Custom emoji may included by colon wrapping the image name.
66.Pq :hellsyeah:
67A meme (sticker, reaction gif) may be included with the
68.Ar meme
69operator followed by the file name.
70.Dl meme: honk.mp4
71A full list of emoji and memes may be found in the
72.Pa funzone .
73.Pp
74There are no length restrictions, but remember, somebody is going to have
75to read this noise.
76.Pp
77One may attach a file to a post.
78Images are automatically rescaled and reduced in size for federation.
79A description, or caption, is encouraged.
80Text files are also supported as attachments.
81Other formats are not supported.
82.Pp
83One may also check in to a location.
84The available fields, all optional, are
85.Ar name ,
86.Ar url ,
87.Ar latitude ,
88and
89.Ar longitude .
90By default, location data is rounded to approximately 1/100 decimal degree
91accuracy.
92Pressing the check in button a second time will refine this to more a
93precise location.
94.Pp
95When everything is at last ready to go, press the
96.Dq it's gonna be honked
97button.
98.Ss zonkzone
99Sometimes other users of the federation can get unruly.
100The zonkzone can be of great use to restore order to one's timeline.
101.Sh SEE ALSO
102.Xr honk 8
103.Sh STANDARDS
104.Pp
105.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
106.Pp
107.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
108.Sh HISTORY
109Started March 2019.
110.Sh AUTHORS
111Ted Unangst.
112.Sh CAVEATS
113The ActivityPub standard is subject to interpretation, and not all
114implementations are as enlightened as
115.Nm .
116.Sh BUGS
117Only features.