openidec/man/idecd.1

90 lines
2.1 KiB
Groff

.TH IDECD 1 "March 12, 2023" "version 0.0.1" "OpenIDEC"
.SH NAME
idecd - ii/idec node
.SH SYNOPSIS
.B idecd
[options]
.SH DESCRIPTION
ii/idec node
.SH OPTIONS
.TP
-L
Listen address, default is :8080
.TP
-db db/filename
Database, "db" by default
.TP
-e path
Echos list file. This file needs only for descriptions and must be in list.txt format, where 2nd colum is ignored. When this file is exists, points can not create they own echos. (list.txt by default)
.TP
-host url
Host string for node. (http://127.0.0.1:8080 by default)
.TP
-noreg
Disable new users registration
.TP
-style path
Path to /style web-directory (css/images) (default "./style")
.TP
-sys "name"
Node name. "OpenIDEC" by default
.TP
-tpl path
Path to html templates (default "./tpl")
.TP
-u points/filename
Points file. "points.txt" by default.
.TP
-v
Be verbose (for tracing)
.SH STANDARTS SUPPORTED
.TP
.BI u/e
.TP
.BI list.txt
.TP
.BI x/c
.TP
.BI blacklist.txt
.TP
.BI m/
.TP
.BI e/
.SH LIMITATIONS
Size of message can not be greater then 65536 bytes (before encoded into base64).
.SH WEB INTERFACE
User with id 1 (first created user) is admin.
.PP
Admin can create new echoes with: http://127.0.0.1:8080/new
.PP
Another hiden feature, is blacklisting: http://127.0.0.1:8080/msgid/blacklist
.PP
.TP
Web interface supports some non-standart features in message body text:
.nf
@spolier: spoiler
@base64: name (base64 data from next line till end of message)
xpm2 and xpm3 images embedding
.fi
.SH RSS
http://127.0.0.1:8080/echo/all/rss - All messages
.PP
http://127.0.0.1:8080/echo/echo.name/rss - By echo.name
.PP
http://127.0.0.1:8080/to/User/rss - For User
.PP
http://127.0.0.1:8080/from/User/rss - From User
.SH EXAMPLES
Fetch db and start node:
.nf
idecctl fetch http://hugeping.tk # get database from remote node
ftp http://hugeping.tk/list.text # for echo descriptions
idecd -sys "newnode" -tpl www/tpl -style www/style # run node with name "newnode"
.fi
.SH
ATTENTION!
by default, a new user is added blocked, set 'locked/no' in points.txt to unlock
.SH SEE ALSO
idecctl(1), openidec(1), idecgmi(1)
.SH AUTHOR
hugeping ( gl00my (at) mail.ru )