You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

122 lines
1.9 KiB

.TH "edlog++" 1 "15 DEC 2021" "" "General Operation Manual"
.SH NAME
\fBedlog++\fP - Python rewrite of the `shlog` utility on RTC
.SH SYNOPSIS
.nf
.fam C
\fBedlog++\fP [\fIoptions\fP]
.fam T
.fi
.SH DESCRIPTION
\fBedlog++\fP was heavily inspired by \fIed(1)\fP and \fImail(1)\fP standard UNIX utilities. In the tradition of the tools, it doesn't try to control the flow of the text on the screen, leaving the scrolling to the terminal it runs in.
.SH OPTIONS
.TP
.B
\fB-h\fP
Display usage help and exit.
.TP
.B
\fB-m\fP
Enable Markdown formatting.
.B
.TP
.B
\fB-p\fP
Enable external pager.
.B
.TP
.B
\fB-w\fP
Enable line wrapping.
.TP
.B
\fB--since TIME\fB
Diplay shlogs newer than TIME (seconds since begin of the Epoch).
.TP
.B
\fB--user USER\fB
Diplay shlogs authored by USER.
.SH FILES & SYSTEM VARS
\fBedlog++\fP accesses the shlogs, contrary to it's predecessor, directly in users' \fI.shlog\fP folders.
.TP
\fBedlog++\fP recognises at the moment the standard \fIPAGER\fP and \fIEDITOR\fP environment variables.
.SH KEYS
.TP
.B
\fB?\fP
help
.TP
.B
\fBg\fP
go back to the first page
.TP
.B
\fBG\fP
go to the oldest message / last page
.TP
.B
\fB4 digit number\fP
jump directly to shlog number
.TP
.B
\fBn\fP
next post
.TP
.B
\fBp\fP
previous post
.TP
.B
\fBm\fP
make new post
.TP
.B
\fBr\fP
reply
.TP
.B
\fBEnter\fP
type current shlog
.TP
.B
\fBz\fP
next screenful of headers
.TP
.B
\fBh\fP
redisplay headers
.TP
.B
\fBH\fP
reload and redisplay headers
.TP
.B
\fBq\fP
quit
.TP
.B
\fB!\fIcommand\fP
execute \fIcommand\fP. Accepts optional parameters {f} - filename, {t} - title, {a} - author, {d} - date of the shlog
.SH SWITCHES
.TP
.B
\fB:wrap/:nowrap\fP
toggle line wrapping
.TP
.B
\fB:md/:nomd\fP
activate/deactivate Markdown formatting (formatted/raw)
.TP
.B
\fB:pager/:nopager\fP
activate/deactivate external pager ("less" for now)
.SH BUGS
Yes.
.SH LINKS
.B
Source Code Repository
https://git.rawtext.club/samhunter/edlogxx
.SH AUTHORS
\fBedlog++\fP is developed by samhunter