summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar shtrophic2025-03-08 22:29:50 +0100
committerGravatar shtrophic2025-03-08 22:29:50 +0100
commit398b733b2c0ff4c96f4de9731a864373842e86d6 (patch)
treee2a381ee39d7139cf13c953c5ddad8e59bf8163f /doc
parentMerge branch 'master' into curl-smtp (diff)
parentUpdated RELEASE_NOTES. (diff)
downloadsnac2-398b733b2c0ff4c96f4de9731a864373842e86d6.tar.gz
snac2-398b733b2c0ff4c96f4de9731a864373842e86d6.tar.xz
snac2-398b733b2c0ff4c96f4de9731a864373842e86d6.zip
Merge remote-tracking branch 'upstream/master' into curl-smtp
Diffstat (limited to 'doc')
-rw-r--r--doc/snac.117
-rw-r--r--doc/snac.829
2 files changed, 45 insertions, 1 deletions
diff --git a/doc/snac.1 b/doc/snac.1
index 327e071..601ce6d 100644
--- a/doc/snac.1
+++ b/doc/snac.1
@@ -78,8 +78,17 @@ Fediverse identifier to follow.
78.It Boost (by URL) 78.It Boost (by URL)
79Fill the input area with the URL of a Fediverse note to be 79Fill the input area with the URL of a Fediverse note to be
80boosted. 80boosted.
81.It Like (by URL)
82Fill the input area with the URL of a Fediverse note to be
83liked.
81.It User setup... 84.It User setup...
82This option opens the user setup dialog. 85This option opens the user setup dialog.
86.It Followed hashtags...
87Enter here the list of hashtags you want to follow, one
88per line, with or without the # symbol.
89.It Blocked hashtags...
90Enter here the list of hashtags you want to block, one
91per line, with or without the # symbol.
83.El 92.El
84.Pp 93.Pp
85The user setup dialog allows some user information to be 94The user setup dialog allows some user information to be
@@ -151,6 +160,9 @@ approved or discarded.
151If this toggle is set, the number of followers and following 160If this toggle is set, the number of followers and following
152accounts are made public (this is only the number; the specific 161accounts are made public (this is only the number; the specific
153lists of accounts are never published). 162lists of accounts are never published).
163.It Web interface language
164If the administrator has installed any language file, it
165can be selected here.
154.It Password 166.It Password
155Write the same string in these two fields to change your 167Write the same string in these two fields to change your
156password. Don't write anything if you don't want to do this. 168password. Don't write anything if you don't want to do this.
@@ -256,7 +268,8 @@ argument is -e, the external editor defined by the EDITOR
256environment variable will be invoked to prepare a message; if 268environment variable will be invoked to prepare a message; if
257it's - (a lonely hyphen), the post content will be read from stdin. 269it's - (a lonely hyphen), the post content will be read from stdin.
258The rest of command line arguments are treated as media files to be 270The rest of command line arguments are treated as media files to be
259attached to the post. 271attached to the post. The LANG environment variable (if defined) is used
272as the post language.
260.It Cm note_unlisted Ar basedir Ar uid Ar text Op file file ... 273.It Cm note_unlisted Ar basedir Ar uid Ar text Op file file ...
261Like the previous one, but creates an "unlisted" (or "quiet public") post. 274Like the previous one, but creates an "unlisted" (or "quiet public") post.
262.It Cm note_mention Ar basedir Ar uid Ar text Op file file ... 275.It Cm note_mention Ar basedir Ar uid Ar text Op file file ...
@@ -395,6 +408,8 @@ variable. Set it to an integer value. The higher, the deeper in meaningless
395verbiage you'll find yourself into. 408verbiage you'll find yourself into.
396.It Ev EDITOR 409.It Ev EDITOR
397The user-preferred interactive text editor to prepare messages. 410The user-preferred interactive text editor to prepare messages.
411.It Ev LANG
412The language of the post when sending messages.
398.El 413.El
399.Sh SEE ALSO 414.Sh SEE ALSO
400.Xr snac 5 , 415.Xr snac 5 ,
diff --git a/doc/snac.8 b/doc/snac.8
index f1e5590..7594d82 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -264,6 +264,9 @@ The maximum number of entries (posts) to be returned in user RSS feeds and outbo
264(default: 20). 264(default: 20).
265.It Ic max_attachments 265.It Ic max_attachments
266The maximum number of attachments per post (default: 4). 266The maximum number of attachments per post (default: 4).
267.It Ic enable_svg
268Since version 2.73, SVG image attachments are hidden by default; you can enable
269them by setting this value to true.
267.El 270.El
268.Pp 271.Pp
269You must restart the server to make effective these changes. 272You must restart the server to make effective these changes.
@@ -617,6 +620,32 @@ hashtags.
617Please take note that subscribing to relays can increase the traffic towards your instance 620Please take note that subscribing to relays can increase the traffic towards your instance
618significantly. In any case, lowering the "Maximum days to keep posts" value for the relay 621significantly. In any case, lowering the "Maximum days to keep posts" value for the relay
619special user is recommended (e.g. setting to just 1 day). 622special user is recommended (e.g. setting to just 1 day).
623.Ss Web interface language
624Since version 2.73, the web UI can be localized via simple .po files (they are directly
625parsed, no support for gettext is needed).
626.Pp
627No language file is installed by default; the administrator must copy any desired .po files
628to the
629.Pa lang/
630subdirectory in the base directory. Once the server is restarted, users can select the
631new language from the user settings. The
632.Nm
633source distribution may include .po files in the
634.Pa po/
635subdirectory. You don't need to copy the English language one, as it's the default.
636.Pp
637To create new language files, create a copy of
638.Pa po/en.po ,
639rename it to a reasonable value like
640.Pa pl.po
641or
642.Pa pt_BR.po ,
643change the translator in the header to yourself and fill the msgstr strings with your
644translation. If you have any doubt on how to modify .po files, there are many tutorials
645out there. If you want your language file to be included in the standard
646.Nm
647distribution, please send me a link to it via the Fediverse to @grunfink@comam.es
648or make a PR via the Git repository.
620.Sh ENVIRONMENT 649.Sh ENVIRONMENT
621.Bl -tag -width Ds 650.Bl -tag -width Ds
622.It Ev DEBUG 651.It Ev DEBUG