78 lines
1.7 KiB
Groff
78 lines
1.7 KiB
Groff
.Dd January 22, 2026
|
|
.Dt YUKI 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm yuki
|
|
.Nd An alternative client for WriteFreely
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Sy login
|
|
.Op Sy logout
|
|
.Op Sy new Fl t Ar title ...
|
|
.Op Sy rm Fl i Ar id
|
|
.Op Sy update Fl i Ar id ...
|
|
.Sh DESCRIPTION
|
|
This client is written entirely from scratch
|
|
using the go-writefreely library forked from
|
|
go-writeas.
|
|
.Pp
|
|
It can create, remove, and update posts, as
|
|
well as being able to log in and out.
|
|
.Sh USAGE
|
|
.Bl -tag -width 11n
|
|
.It login
|
|
Authenticates a user with WriteFreely
|
|
.It logout
|
|
Un-authenticates a user with WriteFreely,
|
|
permanently invalidating the access token
|
|
used with the request.
|
|
.It new
|
|
This creates a new post, associating it
|
|
with a user account.
|
|
.Pp
|
|
The following options are supported:
|
|
.Bl -tag -width 8n
|
|
.It Fl -collection
|
|
Location for the post, if unset, it
|
|
will be located in Drafts.
|
|
.It Fl -font
|
|
Which font to use for presentation, one of
|
|
sans, serif, wrap (monospace with word-wrapping),
|
|
code (monospace with syntax highlighting) or mono.
|
|
.It Fl -lang
|
|
ISO 639-1 language code for the post.
|
|
.It Fl -rtl
|
|
Whether to use right-to-left writing
|
|
style.
|
|
.It Fl -title
|
|
A title for the post.
|
|
This option is required
|
|
.El
|
|
.It rm
|
|
Delete permanently a post from WriteFreely.
|
|
.Bl -tag -width 8n
|
|
.It Fl -id
|
|
Identifier for the post.
|
|
This option is required
|
|
.El
|
|
.It update
|
|
Update an existing post (this can overwrite it),
|
|
it supports all the options outlined in
|
|
.Sy new ,
|
|
as well as the one in
|
|
.Sy rm
|
|
.El
|
|
.Sh ENVIRONMENT
|
|
.Ev EDITOR - Defaults to
|
|
.Xr vi 1
|
|
in a Unix system, or whatever the
|
|
user has set at a given time.
|
|
.Sh FILES
|
|
.Pa ~/.config/yuki.ini
|
|
.Sh LICENSE
|
|
This work is licensed under the terms of the Internet Systems Consortium License
|
|
.Sh AUTHORS
|
|
.An Shin'ya Minazuki Aq Mt shinyoukai@laidback.moe
|
|
.Sh BUGS
|
|
Hopefully none
|