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