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