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
 31Honks are posted publicly.
 32.Ss BASICS
 33A subset of markdown is supported.
 34.Bl -tag -width tenletters
 35.It bold
 36**bold text**
 37.It italics
 38*italicized text*
 39.It quotes
 40> This text is quoted.
 41.It code
 42Inline `code fragments` with single ticks.
 43.Bd -literal
 44```c
 45/* triple tick code blocks support syntax highlighting */
 46int main() { return 0; }
 47```
 48.Ed
 49.It images
 50Inline images with img tags.
 51.Bd -literal
 52<img alt="Lifecycle of a honk" src="https://example.com/diagram.png">
 53.Ed
 54.It links
 55URLs beginning with
 56.Dq http
 57or
 58.Dq https
 59will be autolinked.
 60.El
 61.Ss EXTRAS
 62Mentioning a specfic user such as
 63.Pq @user@example.social
 64will send a copy of the message to them.
 65Several forms are supported.
 66.Ql @name
 67will work using the short name from the
 68.Pa honkers
 69table and be expanded automatically.
 70.Ql @handle@domain
 71will work for anyone.
 72.Ql @https://example.com
 73works as well.
 74When honking back, the author of the parent post is automatically mentioned.
 75.Pp
 76Threads from the tiny bird site may be included as quotes in a post via the
 77.Ar hoot
 78operator followed by the URL.
 79.Dl hoot: https://twitter.com/tedunangst/status/850379741492367360
 80.Pp
 81Custom emoji may be included by colon wrapping the image name.
 82.Pq :hellsyeah:
 83A meme (sticker, reaction gif) may be included with the
 84.Ar meme
 85operator followed by the file name.
 86.Dl meme: honk.mp4
 87A full list of emoji and memes may be found in the
 88.Pa funzone .
 89.Pp
 90There are no length restrictions, but remember, somebody is going to have
 91to read this noise.
 92.Pp
 93One may attach a file to a post.
 94Images are automatically rescaled and reduced in size for federation.
 95A description, or caption, is encouraged.
 96Text files and PDFs are also supported as attachments.
 97Other formats are not supported.
 98.Pp
 99One may also check in to a location.
100The available fields, all optional, are
101.Ar name ,
102.Ar url ,
103.Ar latitude ,
104and
105.Ar longitude .
106By default, location data is rounded to approximately 1/100 decimal degree
107accuracy.
108Pressing the check in button a second time will refine this to more a
109precise location.
110.Pp
111Adding a time to a post turns it into an event.
112Supported formats for start time are HH:MM or YYYY-MM-DD HH:MM.
113A 24 hour clock is assumed, unless am or pm are specified.
114The duration is optional and may be specified as XdYhZm for X days, Y hours,
115and Z minutes (1d12h would be a 36 hour event).
116.Pp
117When everything is at last ready to go, press the
118.Dq it's gonna be honked
119button.
120.Sh EXAMPLES
121(Slightly dated screenshots.)
122.Pp
123Composing a new honk with an attached image and location.
124.Pp
125.Lk screenshot-compose.png screenshot of honk composition
126.Pp
127After posting.
128.Pp
129.Lk screenshot-afterpost.jpg screenshot of honk after posting
130.Sh SEE ALSO
131.Xr honk 1
132.Sh CAVEATS
133Markdown support is implemented with regexes.
134Preview is recommended.