mirror of
https://github.com/matrix-construct/construct
synced 2024-06-06 03:58:58 +02:00
Complete the table of contents.
parent
497dd10a2d
commit
15ea6f44e4
|
@ -4,16 +4,96 @@ You can use the console (*CTRL-C*) or the *!control:SERVERNAME* room. Riot is su
|
|||
|
||||
Most of these commands are only interesting throughout the betatesting, like unscrewing room or server states, or examining what's going on.
|
||||
|
||||
|
||||
## Table of Contents
|
||||
1. [room](#room)
|
||||
2. [rooms](#rooms)
|
||||
3. [conf](#conf)
|
||||
4. [log](#log)
|
||||
5. [fed](#fed)
|
||||
6. [db](#db)
|
||||
7. [user](#user)
|
||||
8. [redact](#redact)
|
||||
9. [mod](#mod)
|
||||
|
||||
##### Commands for a specific element of Matrix:
|
||||
|
||||
1. `$` [event](#event) - Atomic unit of Matrix protocol.
|
||||
2. `!` [room](#room) - Collection of events in a timeline.
|
||||
3. `@` [user](#user) - Party to the Matrix Protocol.
|
||||
4. `+` [group](#bridge) - Collection of rooms and users.
|
||||
5. `:` [node](#node) - Collection of users (a.k.a. origin, server).
|
||||
6. [bridge](#bridge) - Management of an application-service.
|
||||
7. [fed](#fed) - Diagnostic for a remote server interaction (federation API).
|
||||
8. [mc](#mc) - Diagnostic for remote server interaction (client API).
|
||||
9. [file](#file) - Diagnostic for media.
|
||||
|
||||
##### Commands for multiple elements of a specific category:
|
||||
|
||||
1. [events](#events) - Diagnostic over multiple/all events known to server.
|
||||
2. [rooms](#rooms) - Diagnostic over multiple/all rooms known to server.
|
||||
3. [users](#users) - Diagnostic over multiple/all users known to server.
|
||||
4. [groups](#groups) - Diagnostic over multiple/all groups known to server.
|
||||
5. [bridges](#bridges) - Diagnostic over multiple/all registered application-services.
|
||||
6. [feds](#feds) - Performs equivalent diagnostic to [fed](#fed) over multiple/all servers in a room.
|
||||
|
||||
##### Other Matrix application suites:
|
||||
|
||||
1. [vm](#vm) - Information about event dispatch; core processing.
|
||||
2. [hook](#hook) - Information about event listeners.
|
||||
3. [synchron](#synchron) - Information about synchronizing clients.
|
||||
4. [redact](#redact) - Quick shortcut to redact an event.
|
||||
5. [fetch](#fetch) - Diagnostic to fetch an event from any server in a room.
|
||||
6. [stage](#stage) - Create and manipulate events from scratch in console memory (difficult interface).
|
||||
|
||||
### General Server Operation
|
||||
|
||||
##### Primary Information
|
||||
|
||||
- [help](#help) - List commands or information about a command.
|
||||
- [credits](#credits) - Information about the project, license and contributors.
|
||||
- [version](#version) - The server's current version (N.B. `version -a`).
|
||||
- [versions](#versions) - Versions from library and system dependencies.
|
||||
|
||||
##### Primary Administration
|
||||
|
||||
- [exit](#exit) - Close the console (ctrl-d/EOF).
|
||||
- [sync](#sync) - Force flush and synchronize to local storage.
|
||||
- [restart](#restart) - Restart the server.
|
||||
- [die](#die) - Shutdown the server.
|
||||
|
||||
##### Subsystem Administration
|
||||
|
||||
- [aio](#aio) - Information about Linux AIO (on available systems).
|
||||
- [conf](#conf) - List and control server configuration.
|
||||
- [ctx](#ctx) - Userspace threading lists and controls.
|
||||
- [db](#db) - Database system interface.
|
||||
- [fs](#fs) - Miscellaneous filesystem related commands.
|
||||
- [ios](#ios) - Core event loop diagnostics.
|
||||
- [log](#log) - Logging system interface.
|
||||
- [mem](#mem) - Dynamic memory interface.
|
||||
- [mod](#mod) - Dynamic module system.
|
||||
- [net](#net) - Miscellaneous network related commands.
|
||||
- [prof](#prof) - Profiling and performance related.
|
||||
- [stats](#stats) - Server statistics and tickers.
|
||||
|
||||
##### Top-level Networking Related:
|
||||
|
||||
- [client](#client) - Information and control over connected clients.
|
||||
- [host](#host) - Domain Name System diagnostic suite.
|
||||
- [peer](#peer) - Information and controls for connections to other servers.
|
||||
- [resource](#resource) - Information about the registered HTTP handler hierarchy.
|
||||
- [well_known](#well_known) - well-known diagnostic (i.e. `well_known matrix server <host>`)
|
||||
|
||||
##### Miscellaneous Diagnostics & Tools:
|
||||
|
||||
- [date](#date) - Diagnostic for the current date and time.
|
||||
- [env](#env) - Posix environment variables for server (N.B. `env *`).
|
||||
- [icu](#icu) - Diagnostic explaining all characters (including hidden) given as argument.
|
||||
- [ls](#ls) - Convenience browser of the server's `$PWD`
|
||||
- [mark](#mark) - Immediately mark the logfiles with a message which can be searched for later.
|
||||
- [proc](#proc) - Convenience browser of `/proc/self/` (i.e. `proc sched` `proc net` `proc net/tcp`)
|
||||
- [stringify](#stringify) - Diagnostic outputting canonical JSON from argument.
|
||||
- [uptime](#uptime) - Duration the server has been running.
|
||||
|
||||
##### Developer Diagnostics & Tools:
|
||||
|
||||
- [bt](#bt) - Print a backtrace.
|
||||
- [debug](#debug) - Toggle debug logging.
|
||||
- [demangle](#demangle) - Diagnostic for symbol name mangling.
|
||||
- [test](#test) - dlsym(3) the function `bool ircd::ircd_test(const string_view &)` and pass argument.
|
||||
- [vg](#vg) - Valgrind hypercall interface (when running in valgrind).
|
||||
|
||||
## MXID-as-command
|
||||
A Matrix-ID itself is recognized as a command for convenience.
|
||||
|
|
Loading…
Reference in a new issue