Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
IAMB(1)			    General Commands Manual		       IAMB(1)

NAME
       iamb -- a terminal-based	client for Matrix for the Vim addict

SYNOPSIS
       iamb [-hV] [-P profile] [-C dir]

DESCRIPTION
       iamb  is	a client for the Matrix	communication protocol.	 It provides a
       terminal	user interface with familiar  Vim  keybindings,	 and  includes
       support	for  multiple  profiles, threads, spaces, notifications, reac-
       tions, custom keybindings, and more.

       This manual page	includes a quick rundown of the	available commands  in
       iamb.  For example usage	and a full description of each one and its ar-
       guments,	please refer to	the full documentation online.

OPTIONS
       -P, --profile
	       The profile to start iamb with.	If this	flag is	not specified,
	       then it defaults	to using default_profile (see iamb(5)).

       -C, --config-directory
	       Path to the directory the configuration file is located in.

       -h, --help
	       Show the	help text and quit.

       -V, --version
	       Show the	current	iamb version and quit.

GENERAL	COMMANDS
       :chats  View a list of joined rooms and direct messages.

       :dms    View a list of direct messages.

       :logout
	       Log out of iamb.

       :rooms  View a list of joined rooms.

       :spaces
	       View a list of joined spaces.

       :unreads
	       View a list of unread rooms.

       :welcome
	       View the	startup	Welcome	window.

E2EE COMMANDS
       :keys export [path] [passphrase]
	       Export and encrypt keys to path.

       :keys import [path] [passphrase]
	       Import and decrypt keys from path.

       :verify
	       View a list of ongoing E2EE verifications.

MESSAGE	COMMANDS
       :download
	       Download	an attachment from the selected	message.

       :edit   Edit the	selected message.

       :editor
	       Open an external	$EDITOR	to compose a message.

       :open   Download	 and then open an attachment, or open a	link in	a mes-
	       sage.

       :react [shortcode]
	       React to	the selected message with an Emoji.

       :redact [reason]
	       Redact the selected message.

       :reply  Reply to	the selected message.

       :unreads	clear
	       Mark all	unread rooms as	read.

       :unreact	[shortcode]
	       Remove your reaction from the selected message.	When no	 argu-
	       ments are given,	remove all of your reactions from the message.

       :upload
	       Upload  an  attachment  and  send  it to	the currently selected
	       room.

ROOM COMMANDS
       :create
	       Create a	new room.

       :invite accept
	       Accept an invitation to the currently focused room.

       :invite reject
	       Reject an invitation to the currently focused room.

       :invite send [user]
	       Send an invitation to a user  to	 join  the  currently  focused
	       room.

       :join [room]
	       Join a room.

       :leave  Leave the currently focused room.

       :members
	       View a list of members of the currently focused room.

       :room name set [name]
	       Set the name of the currently focused room.

       :room name unset
	       Unset the name of the currently focused room.

       :room notify set	[level]
	       Set a notification level	for the	currently focused room.	 Valid
	       levels  are  "mute",  "mentions",  "keywords", and "all".  Note
	       that "mentions" and "keywords" are aliases for the same	behav-
	       iour.

       :room notify unset
	       Unset any room-level notification configuration.

       :room notify show
	       Show the	current	room-level notification	configuration.	If the
	       room  is	 using the account-level default, then this will print
	       "default".

       :room tag set [tag]
	       Add a tag to the	currently focused room.

       :room tag unset [tag]
	       Remove a	tag from the currently focused room.

       :room topic set [topic]
	       Set the topic of	the currently focused room.

       :room topic unset
	       Unset the topic of the currently	focused	room.

       :room alias set [alias]
	       Create and point	the given alias	to the room.

       :room alias unset [alias]
	       Delete the provided alias from  the  room's  alternative	 alias
	       list.

       :room alias show
	       Show alternative	aliases	to the room, if	any are	set.

       :room canon set [alias]
	       Set  the	 room's	 canonical alias to the	one provided, and make
	       the previous one	an alternative alias.

       :room canon unset [alias]
	       Delete the room's canonical alias.

       :room canon show
	       Show the	room's canonical alias,	if any is set.

       :room ban [user]	[reason]
	       Ban a user from this room with an optional reason.

       :room unban [user] [reason]
	       Unban a user from this room with	an optional reason.

       :room kick [user] [reason]
	       Kick a user from	this room with an optional reason.

WINDOW COMMANDS
       :horizontal [cmd]
	       Change the behaviour of the given command to be horizontal.

       :leftabove [cmd]
	       Change the behaviour of the given command to  open  before  the
	       current window.

       :only, :on
	       Quit all	but one	window in the current tab.

       :quit, :q
	       Quit a window.

       :quitall, :qa
	       Quit all	windows	in the current tab.

       :resize
	       Resize a	window.

       :rightbelow [cmd]
	       Change  the  behaviour  of  the given command to	open after the
	       current window.

       :split, :sp
	       Horizontally split a window.

       :vertical [cmd]
	       Change the layout of the	following command to be	vertical.

       :vsplit,	:vsp
	       Vertically split	a window.

TAB COMMANDS
       :tab [cmd]
	       Run a command that opens	a window in a new tab.

       :tabclose, :tabc
	       Close a tab.

       :tabedit	[room],	:tabe
	       Open a room in a	new tab.

       :tabrewind, :tabr
	       Go to the first tab.

       :tablast, :tabl
	       Go to the last tab.

       :tabnext, :tabn
	       Go to the next tab.

       :tabonly, :tabo
	       Close all but one tab.

       :tabprevious, :tabp
	       Go to the preview tab.

SLASH COMMANDS
       /markdown, /md
	       Interpret the message body as Markdown markup.  This is the de-
	       fault behaviour.

       /html, /h
	       Send the	message	body as	literal	HTML.

       /plaintext, /plain, /p
	       Do not interpret	any markup in the message body and send	it  as
	       it is.

       /me     Send an emote message.

       /confetti
	       Produces	no effect in iamb, but will display confetti in	Matrix
	       clients that support doing so.

       /fireworks
	       Produces	 no  effect in iamb, but will display fireworks	in Ma-
	       trix clients that support doing so.

       /hearts
	       Produces	no effect in iamb, but will display floating hearts in
	       Matrix clients that support doing so.

       /rainfall
	       Produces	no effect in iamb, but will display rainfall in	Matrix
	       clients that support doing so.

       /snowfall
	       Produces	no effect in iamb, but will display snowfall in	Matrix
	       clients that support doing so.

       /spaceinvaders
	       Produces	no effect in iamb, but will display aliens from	 Space
	       Invaders	in Matrix clients that support doing so.

EXAMPLES
   Example 1: Starting with a specific profile
       To  start  with a profile named personal	instead	of the default_profile
       value:

	     $ iamb -P personal

   Example 2: Using an alternate configuration directory
       By default, iamb	will use the XDG directories, but  you	may  sometimes
       want to store your configuration	elsewhere.

	     $ iamb -C ~/src/iamb-dev/dev-config/

REPORTING BUGS
       Please	 report	   bugs	   in	 iamb	or   its   manual   pages   at
       https://github.com/ulyssa/iamb/issues

SEE ALSO
       iamb(5)

       Extended	documentation is available online at https://iamb.chat

FreeBSD	Ports 14.quarterly	 Mar 24, 2024			       IAMB(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=iamb&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help