fix: Remove extraneous dashes from command help

2026-05-26 20:49:55 +00:00 · 2026-01-12 10:47:19 -05:00
parent a028049e6f
commit 00eeeb78de
34 changed files with 314 additions and 314 deletions
@@ -1,12 +1,12 @@
 <!-- This file is generated by `cargo xtask generate-docs`. Do not edit. -->
 # `!admin appservices`

- Commands for managing appservices
+Commands for managing appservices


 ## `!admin appservices register`

- Register an appservice using its registration YAML
+Register an appservice using its registration YAML

 This command needs a YAML generated by an appservice (such as a bridge), which must be provided in a Markdown code block below the command.

@@ -14,16 +14,16 @@ Registering a new bridge using the ID of an existing bridge will replace the old

 ## `!admin appservices unregister`

- Unregister an appservice using its ID
+Unregister an appservice using its ID

 You can find the ID using the `list-appservices` command.

 ## `!admin appservices show-appservice-config`

- Show an appservice's config using its ID
+Show an appservice's config using its ID

 You can find the ID using the `list-appservices` command.

 ## `!admin appservices list-registered`

- List all the currently registered appservices
+List all the currently registered appservices
@@ -1,7 +1,7 @@
 <!-- This file is generated by `cargo xtask generate-docs`. Do not edit. -->
 # `!admin check`

- Commands for checking integrity
+Commands for checking integrity


 ## `!admin check check-all-users`
@@ -1,20 +1,20 @@
 <!-- This file is generated by `cargo xtask generate-docs`. Do not edit. -->
 # `!admin debug`

- Commands for debugging things
+Commands for debugging things


 ## `!admin debug echo`

- Echo input of admin command
+Echo input of admin command

 ## `!admin debug get-auth-chain`

- Get the auth_chain of a PDU
+Get the auth_chain of a PDU

 ## `!admin debug parse-pdu`

- Parse and print a PDU from a JSON
+Parse and print a PDU from a JSON

 The PDU event is only checked for validity and is not added to the database.

@@ -22,23 +22,23 @@ This command needs a JSON blob provided in a Markdown code block below the comma

 ## `!admin debug get-pdu`

- Retrieve and print a PDU by EventID from the Continuwuity database
+Retrieve and print a PDU by EventID from the Continuwuity database

 ## `!admin debug get-short-pdu`

- Retrieve and print a PDU by PduId from the Continuwuity database
+Retrieve and print a PDU by PduId from the Continuwuity database

 ## `!admin debug get-remote-pdu`

- Attempts to retrieve a PDU from a remote server. **Does not** insert it into the database or persist it anywhere
+Attempts to retrieve a PDU from a remote server. **Does not** insert it into the database or persist it anywhere

 ## `!admin debug get-remote-pdu-list`

- Same as `get-remote-pdu` but accepts a codeblock newline delimited list of PDUs and a single server to fetch from
+Same as `get-remote-pdu` but accepts a codeblock newline delimited list of PDUs and a single server to fetch from

 ## `!admin debug get-room-state`

- Gets all the room state events for the specified room.
+Gets all the room state events for the specified room.

 This is functionally equivalent to `GET /_matrix/client/v3/rooms/{roomid}/state`, except the admin command does *not* check if the sender user is allowed to see state events. This is done because it's implied that server admins here have database access and can see/get room info themselves anyways if they were malicious admins.

@@ -46,49 +46,49 @@ Of course the check is still done on the actual client API.

 ## `!admin debug get-signing-keys`

- Get and display signing keys from local cache or remote server
+Get and display signing keys from local cache or remote server

 ## `!admin debug get-verify-keys`

- Get and display signing keys from local cache or remote server
+Get and display signing keys from local cache or remote server

 ## `!admin debug ping`

- Sends a federation request to the remote server's `/_matrix/federation/v1/version` endpoint and measures the latency it took for the server to respond
+Sends a federation request to the remote server's `/_matrix/federation/v1/version` endpoint and measures the latency it took for the server to respond

 ## `!admin debug force-device-list-updates`

- Forces device lists for all local and remote users to be updated (as having new keys available)
+Forces device lists for all local and remote users to be updated (as having new keys available)

 ## `!admin debug change-log-level`

- Change tracing log level/filter on the fly
+Change tracing log level/filter on the fly

 This accepts the same format as the `log` config option.

 ## `!admin debug verify-json`

- Verify JSON signatures
+Verify JSON signatures

 This command needs a JSON blob provided in a Markdown code block below the command.

 ## `!admin debug verify-pdu`

- Verify PDU
+Verify PDU

 This re-verifies a PDU existing in the database found by ID.

 ## `!admin debug first-pdu-in-room`

- Prints the very first PDU in the specified room (typically m.room.create)
+Prints the very first PDU in the specified room (typically m.room.create)

 ## `!admin debug latest-pdu-in-room`

- Prints the latest ("last") PDU in the specified room (typically a message)
+Prints the latest ("last") PDU in the specified room (typically a message)

 ## `!admin debug force-set-room-state-from-server`

- Forcefully replaces the room state of our local copy of the specified room, with the copy (auth chain and room state events) the specified remote server says.
+Forcefully replaces the room state of our local copy of the specified room, with the copy (auth chain and room state events) the specified remote server says.

 A common desire for room deletion is to simply "reset" our copy of the room. While this admin command is not a replacement for that, if you know you have split/broken room state and you know another server in the room that has the best/working room state, this command can let you use their room state. Such example is your server saying users are in a room, but other servers are saying they're not in the room in question.

@@ -96,47 +96,47 @@ This command will get the latest PDU in the room we know about, and request the

 ## `!admin debug resolve-true-destination`

- Runs a server name through Continuwuity's true destination resolution process
+Runs a server name through Continuwuity's true destination resolution process

 Useful for debugging well-known issues

 ## `!admin debug memory-stats`

- Print extended memory usage
+Print extended memory usage

 Optional argument is a character mask (a sequence of characters in any order) which enable additional extended statistics. Known characters are "abdeglmx". For convenience, a '*' will enable everything.

 ## `!admin debug runtime-metrics`

- Print general tokio runtime metric totals
+Print general tokio runtime metric totals

 ## `!admin debug runtime-interval`

- Print detailed tokio runtime metrics accumulated since last command invocation
+Print detailed tokio runtime metrics accumulated since last command invocation

 ## `!admin debug time`

- Print the current time
+Print the current time

 ## `!admin debug list-dependencies`

- List dependencies
+List dependencies

 ## `!admin debug database-stats`

- Get database statistics
+Get database statistics

 ## `!admin debug trim-memory`

- Trim memory usage
+Trim memory usage

 ## `!admin debug database-files`

- List database files
+List database files

 ## `!admin debug tester`

- Developer test stubs
+Developer test stubs

 ### `!admin debug tester panic`

@@ -1,24 +1,24 @@
 <!-- This file is generated by `cargo xtask generate-docs`. Do not edit. -->
 # `!admin federation`

- Commands for managing federation
+Commands for managing federation


 ## `!admin federation incoming-federation`

- List all rooms we are currently handling an incoming pdu from
+List all rooms we are currently handling an incoming pdu from

 ## `!admin federation disable-room`

- Disables incoming federation handling for a room
+Disables incoming federation handling for a room

 ## `!admin federation enable-room`

- Enables incoming federation handling for a room again
+Enables incoming federation handling for a room again

 ## `!admin federation fetch-support-well-known`

- Fetch `/.well-known/matrix/support` from the specified server
+Fetch `/.well-known/matrix/support` from the specified server

 Despite the name, this is not a federation endpoint and does not go through the federation / server resolution process as per-spec this is supposed to be served at the server_name.

@@ -26,4 +26,4 @@ Respecting homeservers put this file here for listing administration, moderation

 ## `!admin federation remote-user-in-rooms`

- Lists all the rooms we share/track with the specified *remote* user
+Lists all the rooms we share/track with the specified *remote* user
@@ -11,13 +11,13 @@ Admin commands allow server administrators to manage the server from within thei

 ## Categories

- [`!admin appservices`](appservices/) - Commands for managing appservices
- [`!admin users`](users/) - Commands for managing local users
- [`!admin token`](token/) - Commands for managing registration tokens
- [`!admin rooms`](rooms/) - Commands for managing rooms
- [`!admin federation`](federation/) - Commands for managing federation
- [`!admin server`](server/) - Commands for managing the server
- [`!admin media`](media/) - Commands for managing media
- [`!admin check`](check/) - Commands for checking integrity
- [`!admin debug`](debug/) - Commands for debugging things
- [`!admin query`](query/) - Low-level queries for database getters and iterators
+- [`!admin appservices`](appservices/): Commands for managing appservices
+- [`!admin users`](users/): Commands for managing local users
+- [`!admin token`](token/): Commands for managing registration tokens
+- [`!admin rooms`](rooms/): Commands for managing rooms
+- [`!admin federation`](federation/): Commands for managing federation
+- [`!admin server`](server/): Commands for managing the server
+- [`!admin media`](media/): Commands for managing media
+- [`!admin check`](check/): Commands for checking integrity
+- [`!admin debug`](debug/): Commands for debugging things
+- [`!admin query`](query/): Low-level queries for database getters and iterators
@@ -1,16 +1,16 @@
 <!-- This file is generated by `cargo xtask generate-docs`. Do not edit. -->
 # `!admin media`

- Commands for managing media
+Commands for managing media


 ## `!admin media delete`

- Deletes a single media file from our database and on the filesystem via a single MXC URL or event ID (not redacted)
+Deletes a single media file from our database and on the filesystem via a single MXC URL or event ID (not redacted)

 ## `!admin media delete-list`

- Deletes a codeblock list of MXC URLs from our database and on the filesystem. This will always ignore errors
+Deletes a codeblock list of MXC URLs from our database and on the filesystem. This will always ignore errors

 ## `!admin media delete-past-remote-media`

@@ -27,15 +27,15 @@ default.
  * Delete all remote and local media from 3 days ago, up until now:

    `!admin media delete-past-remote-media -a 3d
--yes-i-want-to-delete-local-media`
+-yes-i-want-to-delete-local-media`

 ## `!admin media delete-all-from-user`

- Deletes all the local media from a local user on our server. This will always ignore errors by default
+Deletes all the local media from a local user on our server. This will always ignore errors by default

 ## `!admin media delete-all-from-server`

- Deletes all remote media from the specified remote server. This will always ignore errors by default
+Deletes all remote media from the specified remote server. This will always ignore errors by default

 ## `!admin media get-file-info`

@@ -1,48 +1,48 @@
 <!-- This file is generated by `cargo xtask generate-docs`. Do not edit. -->
 # `!admin query`

- Low-level queries for database getters and iterators
+Low-level queries for database getters and iterators


 ## `!admin query account-data`

- account_data.rs iterators and getters
+account_data.rs iterators and getters

 ### `!admin query account-data changes-since`

- Returns all changes to the account data that happened after `since`
+Returns all changes to the account data that happened after `since`

 ### `!admin query account-data account-data-get`

- Searches the account data for a specific kind
+Searches the account data for a specific kind

 ## `!admin query appservice`

- appservice.rs iterators and getters
+appservice.rs iterators and getters

 ### `!admin query appservice get-registration`

- Gets the appservice registration info/details from the ID as a string
+Gets the appservice registration info/details from the ID as a string

 ### `!admin query appservice all`

- Gets all appservice registrations with their ID and registration info
+Gets all appservice registrations with their ID and registration info

 ## `!admin query presence`

- presence.rs iterators and getters
+presence.rs iterators and getters

 ### `!admin query presence get-presence`

- Returns the latest presence event for the given user
+Returns the latest presence event for the given user

 ### `!admin query presence presence-since`

- Iterator of the most recent presence updates that happened after the event with id `since`
+Iterator of the most recent presence updates that happened after the event with id `since`

 ## `!admin query room-alias`

- rooms/alias.rs iterators and getters
+rooms/alias.rs iterators and getters

 ### `!admin query room-alias resolve-local-alias`

@@ -50,15 +50,15 @@ _(no description)_

 ### `!admin query room-alias local-aliases-for-room`

- Iterator of all our local room aliases for the room ID
+Iterator of all our local room aliases for the room ID

 ### `!admin query room-alias all-local-aliases`

- Iterator of all our local aliases in our database with their room IDs
+Iterator of all our local aliases in our database with their room IDs

 ## `!admin query room-state-cache`

- rooms/state_cache iterators and getters
+rooms/state_cache iterators and getters

 ### `!admin query room-state-cache server-in-room`

@@ -126,7 +126,7 @@ _(no description)_

 ## `!admin query room-timeline`

- rooms/timeline iterators and getters
+rooms/timeline iterators and getters

 ### `!admin query room-timeline pdus`

@@ -138,7 +138,7 @@ _(no description)_

 ## `!admin query globals`

- globals.rs iterators and getters
+globals.rs iterators and getters

 ### `!admin query globals database-version`

@@ -154,19 +154,19 @@ _(no description)_

 ### `!admin query globals signing-keys-for`

- This returns an empty `Ok(BTreeMap<..>)` when there are no keys found for the server
+This returns an empty `Ok(BTreeMap<..>)` when there are no keys found for the server

 ## `!admin query sending`

- sending.rs iterators and getters
+sending.rs iterators and getters

 ### `!admin query sending active-requests`

- Queries database for all `servercurrentevent_data`
+Queries database for all `servercurrentevent_data`

 ### `!admin query sending active-requests-for`

- Queries database for `servercurrentevent_data` but for a specific destination
+Queries database for `servercurrentevent_data` but for a specific destination

 This command takes only *one* format of these arguments:

@@ -176,7 +176,7 @@ See src/service/sending/mod.rs for the definition of the `Destination` enum

 ### `!admin query sending queued-requests`

- Queries database for `servernameevent_data` which are the queued up requests that will eventually be sent
+Queries database for `servernameevent_data` which are the queued up requests that will eventually be sent

 This command takes only *one* format of these arguments:

@@ -190,7 +190,7 @@ _(no description)_

 ## `!admin query users`

- users.rs iterators and getters
+users.rs iterators and getters

 ### `!admin query users count-users`

@@ -274,7 +274,7 @@ _(no description)_

 ## `!admin query resolver`

- resolver service
+resolver service

 ### `!admin query resolver destinations-cache`

@@ -286,15 +286,15 @@ Query the overrides cache

 ## `!admin query pusher`

- pusher service
+pusher service

 ### `!admin query pusher get-pushers`

- Returns all the pushers for the user
+Returns all the pushers for the user

 ## `!admin query short`

- short service
+short service

 ### `!admin query short short-event-id`

@@ -306,56 +306,56 @@ _(no description)_

 ## `!admin query raw`

- raw service
+raw service

 ### `!admin query raw raw-maps`

- List database maps
+List database maps

 ### `!admin query raw raw-get`

- Raw database query
+Raw database query

 ### `!admin query raw raw-del`

- Raw database delete (for string keys)
+Raw database delete (for string keys)

 ### `!admin query raw raw-keys`

- Raw database keys iteration
+Raw database keys iteration

 ### `!admin query raw raw-keys-sizes`

- Raw database key size breakdown
+Raw database key size breakdown

 ### `!admin query raw raw-keys-total`

- Raw database keys total bytes
+Raw database keys total bytes

 ### `!admin query raw raw-vals-sizes`

- Raw database values size breakdown
+Raw database values size breakdown

 ### `!admin query raw raw-vals-total`

- Raw database values total bytes
+Raw database values total bytes

 ### `!admin query raw raw-iter`

- Raw database items iteration
+Raw database items iteration

 ### `!admin query raw raw-keys-from`

- Raw database keys iteration
+Raw database keys iteration

 ### `!admin query raw raw-iter-from`

- Raw database items iteration
+Raw database items iteration

 ### `!admin query raw raw-count`

- Raw database record count
+Raw database record count

 ### `!admin query raw compact`

- Compact database
+Compact database
@@ -1,83 +1,83 @@
 <!-- This file is generated by `cargo xtask generate-docs`. Do not edit. -->
 # `!admin rooms`

- Commands for managing rooms
+Commands for managing rooms


 ## `!admin rooms list-rooms`

- List all rooms the server knows about
+List all rooms the server knows about

 ## `!admin rooms info`

- View information about a room we know about
+View information about a room we know about

 ### `!admin rooms info list-joined-members`

- List joined members in a room
+List joined members in a room

 ### `!admin rooms info view-room-topic`

- Displays room topic
+Displays room topic

 Room topics can be huge, so this is in its own separate command

 ## `!admin rooms moderation`

- Manage moderation of remote or local rooms
+Manage moderation of remote or local rooms

 ### `!admin rooms moderation ban-room`

- Bans a room from local users joining and evicts all our local users (including server admins) from the room. Also blocks any invites (local and remote) for the banned room, and disables federation entirely with it
+Bans a room from local users joining and evicts all our local users (including server admins) from the room. Also blocks any invites (local and remote) for the banned room, and disables federation entirely with it

 ### `!admin rooms moderation ban-list-of-rooms`

- Bans a list of rooms (room IDs and room aliases) from a newline delimited codeblock similar to `user deactivate-all`. Applies the same steps as ban-room
+Bans a list of rooms (room IDs and room aliases) from a newline delimited codeblock similar to `user deactivate-all`. Applies the same steps as ban-room

 ### `!admin rooms moderation unban-room`

- Unbans a room to allow local users to join again
+Unbans a room to allow local users to join again

 ### `!admin rooms moderation list-banned-rooms`

- List of all rooms we have banned
+List of all rooms we have banned

 ## `!admin rooms alias`

- Manage rooms' aliases
+Manage rooms' aliases

 ### `!admin rooms alias set`

- Make an alias point to a room
+Make an alias point to a room

 ### `!admin rooms alias remove`

- Remove a local alias
+Remove a local alias

 ### `!admin rooms alias which`

- Show which room is using an alias
+Show which room is using an alias

 ### `!admin rooms alias list`

- List aliases currently being used
+List aliases currently being used

 ## `!admin rooms directory`

- Manage the room directory
+Manage the room directory

 ### `!admin rooms directory publish`

- Publish a room to the room directory
+Publish a room to the room directory

 ### `!admin rooms directory unpublish`

- Unpublish a room to the room directory
+Unpublish a room to the room directory

 ### `!admin rooms directory list`

- List rooms that are published
+List rooms that are published

 ## `!admin rooms exists`

- Check if we know about a room
+Check if we know about a room
@@ -1,53 +1,53 @@
 <!-- This file is generated by `cargo xtask generate-docs`. Do not edit. -->
 # `!admin server`

- Commands for managing the server
+Commands for managing the server


 ## `!admin server uptime`

- Time elapsed since startup
+Time elapsed since startup

 ## `!admin server show-config`

- Show configuration values
+Show configuration values

 ## `!admin server reload-config`

- Reload configuration values
+Reload configuration values

 ## `!admin server list-features`

- List the features built into the server
+List the features built into the server

 ## `!admin server memory-usage`

- Print database memory usage statistics
+Print database memory usage statistics

 ## `!admin server clear-caches`

- Clears all of Continuwuity's caches
+Clears all of Continuwuity's caches

 ## `!admin server backup-database`

- Performs an online backup of the database (only available for RocksDB at the moment)
+Performs an online backup of the database (only available for RocksDB at the moment)

 ## `!admin server list-backups`

- List database backups
+List database backups

 ## `!admin server admin-notice`

- Send a message to the admin room
+Send a message to the admin room

 ## `!admin server reload-mods`

- Hot-reload the server
+Hot-reload the server

 ## `!admin server restart`

- Restart the server
+Restart the server

 ## `!admin server shutdown`

- Shutdown the server
+Shutdown the server
@@ -1,17 +1,17 @@
 <!-- This file is generated by `cargo xtask generate-docs`. Do not edit. -->
 # `!admin token`

- Commands for managing registration tokens
+Commands for managing registration tokens


 ## `!admin token issue`

- Issue a new registration token
+Issue a new registration token

 ## `!admin token revoke`

- Revoke a registration token
+Revoke a registration token

 ## `!admin token list`

- List all registration tokens
+List all registration tokens
@@ -1,26 +1,26 @@
 <!-- This file is generated by `cargo xtask generate-docs`. Do not edit. -->
 # `!admin users`

- Commands for managing local users
+Commands for managing local users


 ## `!admin users create-user`

- Create a new user
+Create a new user

 ## `!admin users reset-password`

- Reset user password
+Reset user password

 ## `!admin users deactivate`

- Deactivate a user
+Deactivate a user

 User will be removed from all rooms by default. Use --no-leave-rooms to not leave all rooms by default.

 ## `!admin users deactivate-all`

- Deactivate a list of users
+Deactivate a list of users

 Recommended to use in conjunction with list-local-users.

@@ -34,13 +34,13 @@ This command needs a newline separated list of users provided in a Markdown code

 ## `!admin users logout`

- Forcefully log a user out of all of their devices.
+Forcefully log a user out of all of their devices.

 This will invalidate all access tokens for the specified user, effectively logging them out from all sessions. Note that this is destructive and may result in data loss for the user, such as encryption keys. Use with caution. Can only be used in the admin room.

 ## `!admin users suspend`

- Suspend a user
+Suspend a user

 Suspended users are able to log in, sync, and read messages, but are not able to send events nor redact them, cannot change their profile, and are unable to join, invite to, or knock on rooms.

@@ -48,83 +48,83 @@ Suspended users can still leave rooms and deactivate their account. Suspending t

 ## `!admin users unsuspend`

- Unsuspend a user
+Unsuspend a user

 Reverses the effects of the `suspend` command, allowing the user to send messages, change their profile, create room invites, etc.

 ## `!admin users lock`

- Lock a user
+Lock a user

 Locked users are unable to use their accounts beyond logging out. This is akin to a temporary deactivation that does not change the user's password. This can be used to quickly prevent a user from accessing their account.

 ## `!admin users unlock`

- Unlock a user
+Unlock a user

 Reverses the effects of the `lock` command, allowing the user to use their account again.

 ## `!admin users enable-login`

- Enable login for a user
+Enable login for a user

 ## `!admin users disable-login`

- Disable login for a user
+Disable login for a user

 Disables login for the specified user without deactivating or locking their account. This prevents the user from obtaining new access tokens, but does not invalidate existing sessions.

 ## `!admin users list-users`

- List local users in the database
+List local users in the database

 ## `!admin users list-joined-rooms`

- Lists all the rooms (local and remote) that the specified user is joined in
+Lists all the rooms (local and remote) that the specified user is joined in

 ## `!admin users force-join-room`

- Manually join a local user to a room
+Manually join a local user to a room

 ## `!admin users force-leave-room`

- Manually leave a local user from a room
+Manually leave a local user from a room

 ## `!admin users force-leave-remote-room`

- Manually leave a remote room for a local user
+Manually leave a remote room for a local user

 ## `!admin users force-demote`

- Forces the specified user to drop their power levels to the room default, if their permissions allow and the auth check permits
+Forces the specified user to drop their power levels to the room default, if their permissions allow and the auth check permits

 ## `!admin users make-user-admin`

- Grant server-admin privileges to a user
+Grant server-admin privileges to a user

 ## `!admin users put-room-tag`

- Puts a room tag for the specified user and room ID.
+Puts a room tag for the specified user and room ID.

 This is primarily useful if you'd like to set your admin room to the special "System Alerts" section in Element as a way to permanently see your admin room without it being buried away in your favourites or rooms. To do this, you would pass your user, your admin room's internal ID, and the tag name `m.server_notice`.

 ## `!admin users delete-room-tag`

- Deletes the room tag for the specified user and room ID
+Deletes the room tag for the specified user and room ID

 ## `!admin users get-room-tags`

- Gets all the room tags for the specified user and room ID
+Gets all the room tags for the specified user and room ID

 ## `!admin users redact-event`

- Attempts to forcefully redact the specified event ID from the sender user
+Attempts to forcefully redact the specified event ID from the sender user

 This is only valid for local users

 ## `!admin users force-join-list-of-local-users`

- Force joins a specified list of local users to join the specified room.
+Force joins a specified list of local users to join the specified room.

 Specify a codeblock of usernames.

@@ -134,7 +134,7 @@ Requires the `--yes-i-want-to-do-this` flag.

 ## `!admin users force-join-all-local-users`

- Force joins all local users to the specified room.
+Force joins all local users to the specified room.

 At least 1 server admin must be in the room to reduce abuse.