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.
 70.Pp
 71.Lk screenshot-honk.png screenshot of one honk
 72.Ss Honking
 73Begin by pressin button marked
 74.Dq it's honking time
 75to activate the honk form.
 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.
 81.Pp
 82One may also check in to a location.
 83The available fields, all optional, are
 84.Ar name ,
 85.Ar url ,
 86.Ar latitude ,
 87and
 88.Ar longitude .
 89By default, location data is rounded to approximately 1/500 decimal degree
 90accuracy.
 91Pressing the check in button a second time will refine this to more a
 92precise location.
 93.Pp
 94A limited subset of markdown is supported, including bold, italics, quotes,
 95and code blocks.
 96Mentioning a specfic user such as
 97.Pq @user@example.social
 98will send a copy of the message to them.
 99When replying, the author of the parent post is automatically mentioned.
100.Pp
101Threads from the tiny bird site may be included as quotes in a post via the
102.Ar hoot
103operator.
104.Dl hoot: https://twitter.com/tedunangst/status/835172824734175234
105.Pp
106Custom emoji may included via colon wrapping
107.Pq :hellsyeah: .
108A meme (sticker, reacion gif) may be included with the
109.Ar meme
110operator.
111.Dl meme: honk.mp4
112A full list of emoji and memes may be found in the
113.Pa funzone .
114.Pp
115When everything is at last ready to go, press the
116.Dq it's gonna be honked
117button.
118.Ss zonkzone
119Sometimes other users of the federation can get unruly.
120The zonkzone can be of great use to restore order to one's timeline.
121.Sh SEE ALSO
122.Xr honk 8
123.Sh STANDARDS
124.Pp
125.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
126.Pp
127.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
128.Sh HISTORY
129Started March 2019.
130.Sh AUTHORS
131Ted Unangst.
132.Sh CAVEATS
133Not all ActivityPub implementations work the same way.
134.Sh BUGS
135Only features.