Slixfeed/slixfeed/configs/commands.toml

287 lines
4.5 KiB
TOML
Raw Permalink Normal View History

[all]
all = """
all
Show all options.
"""
2024-01-27 20:21:45 +01:00
[action]
2024-01-28 12:17:31 +01:00
url = """
<url>
2024-02-06 04:04:43 +01:00
Add given <url> to subscription list (prefix http. Default).
2024-01-28 12:17:31 +01:00
"""
add = """
add <url> <title>
Add given <url> to subscription list (no feed validity check). Parameter <title> is optional.
"""
next = """
next <number>
Send next <number> of updates.
"""
2024-01-27 20:21:45 +01:00
[backup]
2024-01-28 12:17:31 +01:00
opml = """
export opml
Send an OPML file with feeds.
"""
md = """
export md
Send a Markdown file with feeds.
"""
# html = """
# backup news html
# Send an HTML formatted file of your news items.
# """
# md = """
# backup news md
# Send a Markdown file of your news items.
# """
# text = """
# backup news text
# Send a Plain Text file of your news items.
# """
2024-01-27 20:21:45 +01:00
2024-02-06 04:04:43 +01:00
[bookmarks]
bookmark = """
bookmark [+|-] <muc>
Groupchat to add or remove.
'+' appends to, '-' removes from.
"""
bookmarks = """
bookmarks
List bookmarked groupchats.
"""
2024-01-27 20:21:45 +01:00
[custom]
2024-01-28 12:17:31 +01:00
new = """
new
Send only new items of newly added feeds.
"""
old = """
old
Send all items of newly added feeds.
"""
2024-01-27 20:21:45 +01:00
[filters]
2024-01-28 12:17:31 +01:00
allow = """
allow [+|-] <keyword>
Keywords to allow
comma-separated keywords
'+' appends to, '-' removes from.
"""
deny = """
deny [+|-] <keyword>
Keywords to block
comma-separated keywords
'+' appends to, '-' removes from.
"""
clear_allow = """
clear allow
2024-01-28 12:17:31 +01:00
Reset allow list.
"""
clear_deny = """
clear deny
2024-01-28 12:17:31 +01:00
Reset deny list.
"""
2024-01-27 20:21:45 +01:00
[groupchat]
2024-02-06 04:04:43 +01:00
uri = """
<muc>
Join groupchat by given <muc> (prefix xmpp).
"""
2024-01-28 12:17:31 +01:00
join = """
join <muc>
Join groupchat by given <muc>.
"""
2024-02-06 04:04:43 +01:00
leave = """
goodbye
Leave groupchat and delete it from bookmarks.
"""
2024-01-27 20:21:45 +01:00
2024-01-28 12:17:31 +01:00
[manual]
all = """
help all
Print a complete list of commands.
"""
2024-01-28 12:17:31 +01:00
help = """
help
Print list of command types.
"""
command = """
help key command
Print command usage and description.
"""
info = """
info
Print information page.
"""
key = """
help <key>
Print list of commands for selected command type.
"""
2024-01-27 20:21:45 +01:00
# [mastership]
# demaster = """
# demaster <nick>
# Remove master privilege from given <nick>.
# """
# mastership = """
# mastership <nick>
# Add master privilege to given <nick>.
# """
# ownership = """
# ownership <nick>
# Transfer ownership to given <nick>.
# """
2024-01-27 20:21:45 +01:00
[message]
2024-01-28 12:17:31 +01:00
interval = """
interval <minutes>
Set interval update to every given <minutes>.
"""
length = """
length <number>
2024-01-28 12:17:31 +01:00
Set maximum length of news item description. (0 for no limit)
"""
media = """
media [off|on]
Attach media (i.e. audio, image, video) to messages when available.
"""
2024-01-28 12:17:31 +01:00
quantum = """
quantum <number>
2024-02-06 04:04:43 +01:00
Set amount of updates per message by given <number>.
"""
random = """
random [off|on]
2024-02-06 04:04:43 +01:00
Send messages by random order instead of date.
2024-01-28 12:17:31 +01:00
"""
2024-01-27 20:21:45 +01:00
[modification]
2024-02-06 04:04:43 +01:00
archive = """
archive <number>
Number of news items to archive (maximum value 500).
"""
default = """
default
Restore default settings.
2024-01-28 12:17:31 +01:00
"""
disable = """
disable <id>
Disable updates for feed of given <id>.
"""
enable = """
enable <id>
Enable updates for feed of given <id>.
"""
rename = """
rename <id> <name>
Rename feed of given <id> with new <name>.
"""
remove = """
remove <id>
Remove feed of from subscription list by given <id>.
"""
2024-01-28 12:17:31 +01:00
reset = """
reset
Mark all entries as read and remove all archived entries
"""
reset_url = """
reset <url>
Mark entries of given <url> as read and remove all its archived entries.
"""
start = """
start
Enable bot and send updates.
"""
stop = """
stop
Disable bot and stop updates.
"""
2024-01-27 20:21:45 +01:00
2024-03-10 00:31:06 +01:00
[options]
options = """
options
List options.
"""
2024-01-27 20:21:45 +01:00
[preview]
2024-01-28 12:17:31 +01:00
read = """
read <url>
Display recent 5 titles of given <url>.
2024-01-28 12:17:31 +01:00
"""
read_num = """
read <url> <index>
Display specified entry number from given <url> by given <index>.
"""
2024-01-27 20:21:45 +01:00
[pubsub]
pubsub = """
pubsub [off|on]
Designate JID as PubSub service.
"""
[send]
send = """
send <pubsub>/<jid> <url> <node>
Send feeds to given JID.
"""
2024-01-27 20:21:45 +01:00
[search]
2024-01-28 12:17:31 +01:00
feeds = """
feeds
List all subscriptions.
"""
feeds_keyword = """
feeds <text>
Search subscriptions by given <text>.
"""
search = """
search <text>
Search news items by given <text>.
"""
recent = """
recent <number>
2024-02-06 04:04:43 +01:00
List recent <number> news items (max. 50).
2024-01-28 12:17:31 +01:00
"""
2024-01-27 20:21:45 +01:00
[statistics]
2024-02-06 04:04:43 +01:00
stats = """
stats
Show general statistics.
"""
[list]
blacklist = """
blacklist
List all blacklisted JIDs.
"""
blacklist_action = """
blacklist [add|delete] <jid>
Manage allowed list.
"""
whitelist = """
whitelist
List all whitelisted JIDs.
"""
whitelist_action = """
whitelist [add|delete] <jid>
Manage denied list.
"""
# analyses = """
# analyses
# Show report and statistics of feeds.
# """
# obsolete = """
# obsolete
# List feeds that are not available.
# """
# unread = """
# unread
# Print number of unread news items.
# """
2024-01-27 20:21:45 +01:00
# [token]
# activate = """
# activate <code>
# Activate given token to command bot by given <code>.
# """