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 headings
 50Heading lines starting with #.
 51.It lists
 52Lists of items starting with either
 53.Sq +
 54or
 55.Sq - .
 56.It tables
 57Table cells separated by |.
 58.It images
 59Inline images with img tags.
 60.Bd -literal
 61<img alt="Lifecycle of a honk" src="https://example.com/diagram.png">
 62.Ed
 63.Pp
 64A src of a single number (1, 2, etc.) may refer to an attachment.
 65.It links
 66URLs beginning with
 67.Dq http
 68or
 69.Dq https
 70will be autolinked.
 71.It rules
 72Exactly three dashes on a line,
 73.Dq --- ,
 74will become a horizontal rule.
 75.It spoilers
 76Hide blocks of text between triple colon delimted regions.
 77.Bd -literal
 78::: warning
 79text that should be hidden behind a warning
 80:::
 81.Ed
 82.El
 83.Pp
 84If the first line of a honk begins with
 85.Dq DZ:
 86(danger zone) or any other combination of two letters and a colon,
 87it will be used a summary and the post marked sensitive.
 88.Pp
 89Mentioning a specfic user such as
 90.Pq @user@example.social
 91will send a copy of the message to them.
 92Several forms are supported.
 93.Ql @name
 94will work using the short name from the
 95.Pa honkers
 96table and be expanded automatically.
 97.Ql @handle@domain
 98will work for anyone.
 99.Ql @https://example.com
100works as well.
101When honking back, the author of the parent post is automatically mentioned.
102.Ss Extras
103Custom emoji may be included by colon wrapping the image name.
104.Pq :hellsyeah:
105A meme (sticker, reaction gif) may be included with the
106.Ar meme
107operator followed by the file name.
108.Dl meme: honk.mp4
109A full list of emoji and memes may be found in the
110.Pa funzone .
111See
112.Xr honk 8
113for more about the funzone.
114.Pp
115Custom flag emoji may be generated on the fly by specifying comma separated
116hexadecimal RGB values, one for each stripe.
117.Dl flag:306,002,dcf
118Vertical stripes may be selected by specfying "vert" for the first value.
119.Pp
120There are no length restrictions, but remember, somebody is going to have
121to read this noise.
122.Pp
123One may attach a file to a post.
124Images are automatically rescaled and reduced in size for federation.
125A description, or caption, is encouraged.
126Text files and PDFs are also supported as attachments.
127Other formats are not supported.
128Multiple files may be attached to the some post, but be wary of depending
129on a particular presentation order.
130.Pp
131One may also live dangerously by posting assassination coordinates.
132The available fields, all optional, are
133.Ar name ,
134.Ar url ,
135.Ar latitude ,
136and
137.Ar longitude .
138By default, location data is rounded to approximately 1/100 decimal degree
139accuracy.
140Pressing the check in button a second time will refine this to more a
141precise location.
142.Pp
143Adding a time to a post turns it into an event.
144Supported formats for start time are HH:MM or YYYY-MM-DD HH:MM.
145A 24 hour clock is assumed, unless am or pm are specified.
146The duration is optional and may be specified as XdYhZm for X days, Y hours,
147and Z minutes (1d12h would be a 36 hour event).
148.Pp
149Clicking the pretty circle face will open the emu peeker to add in the
150selection of emus.
151.Pp
152When everything is at last ready to go, press the
153.Dq it's gonna be honked
154button.
155.Ss Advanced
156Some additional fields exist which modify the post's metadata.
157.Pp
158cc to add a recipient without inlining their address.
159.Pp
160link to add an http Link to the post.
161.Pp
162name to give a title to the link.
163.Pp
164tags to add additional hashtags without cluttering the text.
165.Sh EXAMPLES
166(Slightly dated screenshots.)
167.Pp
168Composing a new honk with an attached image and location.
169.Pp
170.Lk screenshot-compose.png screenshot of honk composition
171.Pp
172After posting.
173.Pp
174.Lk screenshot-afterpost.jpg screenshot of honk after posting
175.Sh SEE ALSO
176.Xr honk 1
177.Sh CAVEATS
178Markdown support is implemented with regexes.
179Preview is recommended.