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