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.Pp
 62If the first line of a honk begins with
 63.Dq DZ:
 64(danger zone) it will be used a summary and the post marked sensitive. 
 65.Pp
 66Mentioning a specfic user such as
 67.Pq @user@example.social
 68will send a copy of the message to them.
 69Several forms are supported.
 70.Ql @name
 71will work using the short name from the
 72.Pa honkers
 73table and be expanded automatically.
 74.Ql @handle@domain
 75will work for anyone.
 76.Ql @https://example.com
 77works as well.
 78When honking back, the author of the parent post is automatically mentioned.
 79.Ss EXTRAS
 80Threads from the tiny bird site may be included as quotes in a post via the
 81.Ar hoot
 82operator followed by the URL.
 83.Dl hoot: https://twitter.com/tedunangst/status/850379741492367360
 84.Pp
 85Custom emoji may be included by colon wrapping the image name.
 86.Pq :hellsyeah:
 87A meme (sticker, reaction gif) may be included with the
 88.Ar meme
 89operator followed by the file name.
 90.Dl meme: honk.mp4
 91A full list of emoji and memes may be found in the
 92.Pa funzone .
 93.Pp
 94There are no length restrictions, but remember, somebody is going to have
 95to read this noise.
 96.Pp
 97One may attach a file to a post.
 98Images are automatically rescaled and reduced in size for federation.
 99A description, or caption, is encouraged.
100Text files and PDFs are also supported as attachments.
101Other formats are not supported.
102.Pp
103One may also check in to a location.
104The available fields, all optional, are
105.Ar name ,
106.Ar url ,
107.Ar latitude ,
108and
109.Ar longitude .
110By default, location data is rounded to approximately 1/100 decimal degree
111accuracy.
112Pressing the check in button a second time will refine this to more a
113precise location.
114.Pp
115Adding a time to a post turns it into an event.
116Supported formats for start time are HH:MM or YYYY-MM-DD HH:MM.
117A 24 hour clock is assumed, unless am or pm are specified.
118The duration is optional and may be specified as XdYhZm for X days, Y hours,
119and Z minutes (1d12h would be a 36 hour event).
120.Pp
121When everything is at last ready to go, press the
122.Dq it's gonna be honked
123button.
124.Sh EXAMPLES
125(Slightly dated screenshots.)
126.Pp
127Composing a new honk with an attached image and location.
128.Pp
129.Lk screenshot-compose.png screenshot of honk composition
130.Pp
131After posting.
132.Pp
133.Lk screenshot-afterpost.jpg screenshot of honk after posting
134.Sh SEE ALSO
135.Xr honk 1
136.Sh CAVEATS
137Markdown support is implemented with regexes.
138Preview is recommended.