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 1
 18.Os
 19.Sh NAME
 20.Nm honk
 21.Nd federated status conveyance
 22.Sh SYNOPSIS
 23.Nm honk
 24.Sh DESCRIPTION
 25The
 26.Nm
 27utility processes status updates and other microblog activities.
 28This is the user manual.
 29For administration, see
 30.Xr honk 8 .
 31.Pp
 32This manual is very incomplete.
 33It'll get there eventually.
 34.Ss Following
 35In order to receive regular updates from other users, one must first follow them.
 36Begin at the
 37.Pa honkers
 38tab.
 39The
 40.Ar url
 41field is required.
 42Either of two forms are accepted, the user's handle (or webfinger) or their
 43ActivityPub actor URL.
 44The
 45.Ar name
 46field is optional and will be automatically inferred.
 47Examples:
 48.Dl @user@example.social
 49.Dl https://example.social/users/user
 50.Pp
 51.Pp
 52After following a fellow honker, they may be added to one or more
 53.Ic combos .
 54These are accessed via the
 55.Pa combos
 56tab and allow easy access to particular groupings.
 57The special combo name of one hyphen
 58.Sq -
 59will remove a honker's posts from the primary feed.
 60.Ss Viewing
 61The primary feed is accessed via the home tab.
 62It will contain posts from all followed honkers.
 63Posts mentioning the user, both followed and not, are collected under the
 64.Pa @me
 65tab.
 66.Pp
 67Individual honks contain a visual representation of the honker's ID,
 68their name, the activity (with a link back to origin), a link to the
 69parent post if applicable, and the convoy (thread) identifier.
 70Screenshot below.
 71.Pp
 72.Lk screenshot-honk.png screenshot of one honk
 73.Pp
 74Available actions are:
 75.Bl -tag -width tenletters
 76.It bonk
 77Share with followers.
 78Not available for nonpublic honks.
 79.It honk back
 80Reply.
 81.It mute
 82Mute this entire thread.
 83Existing posts are hidden, and future posts will not appear in any feed.
 84.It zonk
 85Delete this post.
 86When deleting one's own post, other servers will be requested to remove it,
 87but this is unreliable.
 88.It ack
 89Acknowledge reading this post.
 90Typically if it's a reply to one's own post.
 91.It edit
 92Change it up.
 93Alas, Update activities do not federate reliably.
 94.El
 95.Ss Honking
 96Begin by pressing the button marked
 97.Dq it's honking time
 98to activate the honk form.
 99.Pp
100One may attach a file to a post.
101Images are automatically rescaled and reduced in size for federation.
102A description, or caption, is encouraged.
103Text files are also supported as attachments.
104.Pp
105One may also check in to a location.
106The available fields, all optional, are
107.Ar name ,
108.Ar url ,
109.Ar latitude ,
110and
111.Ar longitude .
112By default, location data is rounded to approximately 1/500 decimal degree
113accuracy.
114Pressing the check in button a second time will refine this to more a
115precise location.
116.Pp
117A limited subset of markdown is supported, including bold, italics, quotes,
118and code blocks.
119URLs beginning with
120.Sq http
121or
122.Sq https
123will be autolinked.
124Mentioning a specfic user such as
125.Pq @user@example.social
126will send a copy of the message to them.
127When honking back, the author of the parent post is automatically mentioned.
128.Pp
129Threads from the tiny bird site may be included as quotes in a post via the
130.Ar hoot
131operator.
132.Dl hoot: https://twitter.com/tedunangst/status/835172824734175234
133.Pp
134Custom emoji may included via colon wrapping
135.Pq :hellsyeah: .
136A meme (sticker, reaction gif) may be included with the
137.Ar meme
138operator.
139.Dl meme: honk.mp4
140A full list of emoji and memes may be found in the
141.Pa funzone .
142.Pp
143There are no length restrictions, but remember, somebody is going to have
144to read this noise.
145When everything is at last ready to go, press the
146.Dq it's gonna be honked
147button.
148.Ss zonkzone
149Sometimes other users of the federation can get unruly.
150The zonkzone can be of great use to restore order to one's timeline.
151.Sh SEE ALSO
152.Xr honk 8
153.Sh STANDARDS
154.Pp
155.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
156.Pp
157.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
158.Sh HISTORY
159Started March 2019.
160.Sh AUTHORS
161Ted Unangst.
162.Sh CAVEATS
163The ActivityPub standard is subject to interpretation, and not all
164implementations are as enlightened as
165.Nm .
166.Sh BUGS
167Only features.