Skip to content

Commit

Permalink
Update for v0.0.10 release (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ulyssa
ulyssa committed Aug 21, 2024
1 parent 66cb542 commit dbf3fcf
Show file tree
Hide file tree
Showing 9 changed files with 327 additions and 50 deletions.
7 changes: 5 additions & 2 deletions src/SUMMARY.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,13 @@
- [Browsing](./rooms/browsing.md)
- [Members](./rooms/members.md)
- [Management](./rooms/management.md)
- [Admin](./rooms/admin.md)
- [Messages](./messages/README.md)
- [Screen Navigation](./layout/README.md)
- [Window Management](./layout/windows.md)
- [Tab Management](./layout/tabs.md)
- [Command Reference](./commands.md)
- [Keybinding Reference](./keybindings.md)
- [Development](./development.md)

[Command Reference](./commands.md)
[Keybinding Reference](./keybindings.md)
[Terminal Comparisons](./terminals.md)
95 changes: 61 additions & 34 deletions src/commands.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,60 @@

## iamb commands

| Command | Aliases | Help |
| ------------------- | ------------------------------------- | ----------------------------------------- |
| `:chats` | | See [Browsing Rooms And DMs Together] |
| `:create` | | See [Room Creation] |
| `:dms` | | See [Browsing Direct Messages] |
| `:download` | | See [Downloading Attachments] |
| `:edit` | | See [Editing Messages] |
| `:editor` | | See [Sending] |
| `:invite accept` | | See [Room Invitations] |
| `:invite reject` | | See [Room Invitations] |
| `:invite send` | | See [Room Invitations] |
| `:join` | | See [Joining And Leaving Rooms] |
| `:keys export` | | See [Exporting / Importing Keys] |
| `:keys import` | | See [Exporting / Importing Keys] |
| `:leave` | | See [Joining And Leaving Rooms] |
| `:logout` | | Log out of the client. |
| `:members` | | See [Viewing Room/Space Members] |
| `:open` | | See [Downloading Attachments] and [Opening Links] |
| `:react` | | See [Reacting To A Message] |
| `:redact` | | See [Redacting A Message] |
| `:reply` | | See [Replying To A Message] |
| `:rooms` | | See [Browsing Rooms] |
| `:room name set` | | See [Setting Room Properties] |
| `:room name unset` | | See [Setting Room Properties] |
| `:room tag set` | | See [Setting Room Tags] |
| `:room tag unset` | | See [Setting Room Tags] |
| `:room topic set` | | See [Setting Room Properties] |
| `:room topic unset` | | See [Setting Room Properties] |
| `:spaces` | | See [Browsing Spaces] |
| `:unreact` | | See [Reacting To A Message] |
| `:upload` | | See [Sending] |
| `:verify` | | See [Verification] |
| `:welcome` | | Shows the startup Welcome window |
| Command | Aliases | Help |
| ------------------- | ------------------------------------- | ----------------------------------------- |
| `:chats` | | See [Browsing Rooms And DMs Together] |
| `:create` | | See [Room Creation] |
| `:dms` | | See [Browsing Direct Messages] |
| `:download` | | See [Downloading Attachments] |
| `:edit` | | See [Editing Messages] |
| `:editor` | | See [Sending] |
| `:invite accept` | | See [Room Invitations] |
| `:invite reject` | | See [Room Invitations] |
| `:invite send` | | See [Room Invitations] |
| `:join` | | See [Joining And Leaving Rooms] |
| `:keys export` | | See [Exporting / Importing Keys] |
| `:keys import` | | See [Exporting / Importing Keys] |
| `:leave` | | See [Joining And Leaving Rooms] |
| `:logout` | | Log out of the client. |
| `:members` | | See [Viewing Room/Space Members] |
| `:open` | | See [Downloading Attachments] and [Opening Links] |
| `:react` | | See [Reacting To A Message] |
| `:redact` | | See [Redacting A Message] |
| `:reply` | | See [Replying To A Message] |
| `:rooms` | | See [Browsing Rooms] |
| `:room alias set` | | See [Setting Room Aliases] |
| `:room alias show` | | See [Setting Room Aliases] |
| `:room alias unset` | | See [Setting Room Aliases] |
| `:room ban` | | See [Managing Room Membership] |
| `:room canon set` | `:room canonicalalias set` | See [Setting Room Aliases] |
| `:room canon show` | `:room canonicalalias show` | See [Setting Room Aliases] |
| `:room canon unset` | `:room canonicalalias unset` | See [Setting Room Aliases] |
| `:room dm unset` | | See [Marking Direct Rooms] |
| `:room dm set` | | See [Marking Direct Rooms] |
| `:room dm unset` | | See [Marking Direct Rooms] |
| `:room history set` | | See [Setting History Visibility] |
| `:room history unset` | | See [Setting History Visibility] |
| `:room kick` | | See [Managing Room Membership] |
| `:room name set` | | See [Setting Room Properties] |
| `:room name show` | | See [Setting Room Properties] |
| `:room name unset` | | See [Setting Room Properties] |
| `:room notify set` | | See [Configuring Room Notifications] |
| `:room notify show` | | See [Configuring Room Notifications] |
| `:room notify unset` | | See [Configuring Room Notifications] |
| `:room tag set` | | See [Setting Room Tags] |
| `:room tag unset` | | See [Setting Room Tags] |
| `:room topic set` | | See [Setting Room Properties] |
| `:room topic show` | | See [Setting Room Properties] |
| `:room topic unset` | | See [Setting Room Properties] |
| `:room unban` | | See [Managing Room Membership] |
| `:spaces` | | See [Browsing Spaces] |
| `:unreact` | | See [Reacting To A Message] |
| `:unreads` | | See [Browsing Unreads] |
| `:unreads clear` | | See [Browsing Unreads] |
| `:upload` | | See [Sending] |
| `:verify` | | See [Verification] |
| `:welcome` | | Shows the startup Welcome window |

## Vim commands

Expand Down Expand Up @@ -80,11 +101,15 @@ table th:nth-of-type(3) {
[Browsing Rooms]: ./rooms/browsing.md#browsing-rooms
[Browsing Rooms And DMs Together]: ./rooms/browsing.md#browsing-rooms-and-dms-together
[Browsing Spaces]: ./rooms/browsing.md#browsing-spaces
[Browsing Unreads]: ./rooms/browsing.md#browsing-unreads
[Closing Tabs]: ./layout/tabs.md#closing-tabs
[Closing Windows]: ./layout/tabs.md#closing-windows
[Configuring Room Notifications]: ./rooms/management.md#configuring-room-notifications
[Downloading Attachments]: ./messages/#downloading-attachments
[Editing Messages]: ./messages/#editing-messages
[Exporting / Importing Keys]: ./e2ee/keys.md#exporting-importing-keys
[Managing Room Membership]: ./rooms/admin.md#managing-room-membership
[Marking Direct Rooms]: ./rooms/management.md#marking-direct-rooms
[Opening Links]: ./messages/#opening-links
[Opening Tabs]: ./layout/tabs.md#opening-tabs
[Opening Windows]: ./layout/tabs.md#opening-windows
Expand All @@ -97,7 +122,9 @@ table th:nth-of-type(3) {
[Room Invitations]: ./rooms/management.md#room-invitations
[Joining And Leaving Rooms]: ./rooms/#joining-and-leaving-rooms
[Sending]: ./messages/#sending
[Setting Room Properties]: ./rooms/management.md#setting-room-properties
[Setting History Visibility]: ./rooms/admin.md#setting-history-visibility
[Setting Room Aliases]: ./rooms/admin.md#setting-room-aliases
[Setting Room Properties]: ./rooms/admin.md#setting-room-properties
[Setting Room Tags]: ./rooms/management.md#setting-room-tags
[Switching Tabs]: ./layout/tabs.md#switching-tabs
[Verification]: ./e2ee/verify.md
Expand Down
5 changes: 5 additions & 0 deletions src/configure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ url = "https://example.com"
| Name | Default | Description |
| ---------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `default_room` | | A default room name or username to open at startup, in place of showing the welcome screen. |
| `external_edit_file_suffix` | `.md` | The file suffix to use when creating temporary files with message contents for `:edit`. (Usually you want the default `.md` for syntax highlighting.) |
| `image_preview` | (unset) | Configures displaying image attachments for terminals that support previewing images. See [Image Previews](#image-previews) below. |
| `log_level` | `"info"` | Configures the minimum log level. Valid values are `"trace"`, `"debug"`, `"info"`, `"warn"` or `"error"`. |
| `message_user_color` | `false` | Whether to color entire messages using the same color used for the sender's username and display name. |
Expand Down Expand Up @@ -167,6 +168,9 @@ you can put the following in your configuration:
enabled = true
```

See [Configuring Room Notifications] for how to adjust the per-room
notification level.

#### Notification fields

| Name | Default | Description |
Expand Down Expand Up @@ -380,6 +384,7 @@ table th:nth-of-type(3) {
[dirs::config_dir]: https://docs.rs/dirs/latest/dirs/fn.config_dir.html
[`${dirs::data_dir}`]: https://docs.rs/dirs/latest/dirs/fn.data_dir.html
[`${dirs::download_dir}`]: https://docs.rs/dirs/latest/dirs/fn.download_dir.html
[Configuring Room Notifications]: ./rooms/management.md#configuring-room-notifications
[iTerm2]: https://iterm2.com/
[Kitty]: https://sw.kovidgoyal.net/kitty/
[well_known_entry]: https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient
26 changes: 20 additions & 6 deletions src/install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ to install something besides the most recent release (e.g. `main` or `v0.0.8`).

### openSUSE Tumbleweed

On openSUSE Tumbleweed a [package][openSUSE] is available from openSUSE Build
Service (OBS). You can install it using OBS Package Installer:
On openSUSE Tumbleweed a [package][openSUSE] is available from the official
repositories. To install it simply run:

```
opi iamb
zypper install iamb
```

### Snap
Expand All @@ -74,7 +74,8 @@ snap install iamb

## GitHub Releases

You can find binaries built for x86\_64 Linux from the [Releases] page on GitHub.
You can find `.deb`, `.rpm` and binaries built for `x86_64` and `aarch64` Linux
from the [Releases] page on GitHub.

## From crates.io

Expand All @@ -98,16 +99,29 @@ $ git clone https://github.com/ulyssa/iamb.git
$ cd iamb
$ cargo build --release
$ ./target/release/iamb --version
iamb 0.0.9 (82645c8)
iamb 0.0.10 (2e6376f)
```

If you would like to build `.deb` or `.rpm` packages from the repository,
you can do so using [cargo-deb] and [cargo-generate-rpm] respectively. For
example:

```
$ cargo deb
Compiling iamb v0.0.10 (/home/ufsm/src/iamb)
Finished `release` profile [optimized] target(s) in 2m 25s
/home/ufsm/src/iamb/target/debian/iamb_0.0.10-1_amd64.deb
```

[AUR helper]: https://wiki.archlinux.org/title/AUR_helpers
[cargo-deb]: https://crates.io/crates/cargo-deb
[cargo-generate-rpm]: https://crates.io/crates/cargo-generate-rpm
[crates.io]: https://crates.io/crates/iamb
[enabled flakes]: https://nixos.wiki/wiki/Flakes#Enable_flakes
[GitHub]: https://github.com/ulyssa/iamb
[homebrew]: https://formulae.brew.sh/formula/iamb#default
[install-snap]: https://snapcraft.io/docs/installing-snapd
[openSUSE]: https://build.opensuse.org/package/show/home%3Asmolsheep/iamb
[openSUSE]: https://build.opensuse.org/package/show/openSUSE:Factory/iamb
[pkgsrc]: https://pkgsrc.smartos.org/
[Releases]: https://github.com/ulyssa/iamb/releases/
[repology]: https://repology.org/project/iamb/versions
30 changes: 30 additions & 0 deletions src/messages/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,25 @@ the PRIMARY selection), then you could paste it with `"*p`.
> text editor, you can use the `:editor` command to launch your configured
> `$EDITOR`.
## Message Slash Commands

You can prefix a message with several different slash commands to change the
message type or format:

- `/me` to send an emote message
- `/html`/`/h` to send an HTML body
- `/plain`/`/p` to send a plaintext body

These slash commands won't appear with any special effects in __iamb__, but do
produce effects in other clients:

- `/confetti` to add confetti effects
- `/fireworks` to add fireworks effects
- `/hearts` to add floating hearts
- `/snowfall` to add snowfall effects
- `/rainfall` to add rainfall effects
- `/spaceinvaders` to add falling [Space Invaders]

## Message Scrollback

You can scroll through messages from the message bar using the following keys:
Expand Down Expand Up @@ -106,6 +125,16 @@ instead. For example, we could have also written the above as:
:react heart
```

If the argument isn't the shortcode name of an Emoji, then you will be prompted
for whether you want to react with the literal text. You can force literal text
by adding a `!` to the argument. For example, none of these will appear as Emoji:

```
:react! heart
:react! laughing
:react! "hello world"
```

If you want to remove a reaction, you can do so with the `:unreact` command. By
default, this will remove all your reactions from the specified message, but
you can give a name if you've made any that you want to keep:
Expand Down Expand Up @@ -154,3 +183,4 @@ browser by typing its assigned character.

[GitHub Emoji shortcodes]: https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md
[open_command]: ./configure.md#Settings
[Space Invaders]: https://en.wikipedia.org/wiki/Space_Invaders
Loading

0 comments on commit dbf3fcf

Please sign in to comment.