Skip to content

Latest commit

 

History

History
263 lines (185 loc) · 8.96 KB

asciisplash-tmux.1.md

File metadata and controls

263 lines (185 loc) · 8.96 KB
title section header footer date
ASCIISPLASH-TMUX
1
User Manual
asciisplash-tmux 1.0.0
March 26, 2022

NAME

asciisplash-tmux - embeds asciisplash in a tmux session

SYNOPSIS

asciisplash-tmux [-a] [-b] [-c num] [-d] [-l script] [-r script] [-R] [-s song] [-t] [-u]

NOTE: asciisplash-tmux can be run by invoking asciiville -S -T ...

See man asciiville for details on how to front-end asciisplash-tmux with asciiville

DESCRIPTION

The asciisplash-tmux command runs the asciisplash command in a tmux session. This enables automatic recording with asciinema, if desired, and simplifies the process of creating and managing a tmux session.

NOTE: The asciisplash-tmux command resides in /usr/share/asciiville/tools/bin/asciisplash-tmux and is intended as a backend for use by the asciiville command.

COMMAND LINE OPTIONS

-a : indicates play audio during ASCIImatics display

-b : indicates use backup song during ASCIImatics display

-c num : specifies number of cycles ASCIImatics effects should run

-d : indicates dual window panes, run two scripts

-l script : specifies a python script to run in the left visualizer pane

-r script : specifies a python script to run in the right visualizer pane

-R : indicates record tmux session with asciinema

-s song : specifies audio file to use as accompaniment

-t : indicates use original plasma effect comments

-u : Displays this usage message and exits

Defaults: : single pane, left pane plasma, right pane julia, recording disabled

EXAMPLES

asciisplash-tmux : Without options, asciisplash-tmux displays the plasma asciimatics script in a single pane of a tmux session.

asciisplash-tmux -a : With the -a option, asciisplash-tmux displays the plasma asciimatics script in a single pane of a tmux session accompanied by a song.

asciisplash-tmux -l julia : With the -l julia option, asciisplash-tmux displays the julia set asciimatics script in a single pane of a tmux session.

asciisplash-tmux -d -l plasma -r julia -R : With these options, asciisplash-tmux displays the plasma asciimatics script in the left pane of a tmux session, the julia set asciimatics script in the right pane of a tmux session and records the session using asciinema. Recordings are stored in the user's $HOME/Videos/ folder.

TMUX USAGE

start new:

tmux

start new with session name:

tmux new -s myname

attach:

tmux a  #  (or at, or attach)

attach to named:

tmux a -t myname

list sessions:

tmux ls

kill session:

tmux kill-session -t myname

Kill all the tmux sessions:

tmux ls | grep : | cut -d. -f1 | awk '{print substr($1, 0, length($1)-1)}' | xargs kill

In tmux, hit the prefix ctrl+b (my modified prefix is ctrl+a) and then:

List all shortcuts

to see all the shortcuts keys in tmux simply use the bind-key ? in my case that would be CTRL-B ?

Sessions

:new<CR>  new session
s  list sessions
$  name session

Windows (tabs)

c  create window
w  list windows
n  next window
p  previous window
f  find window
,  name window
&  kill window

Panes (splits)

%  vertical split
"  horizontal split

o  swap panes
q  show pane numbers
x  kill pane
+  break pane into window (e.g. to select text by mouse to copy)
-  restore pane from window
⍽  space - toggle between layouts
<prefix> q (Show pane numbers, when the numbers show up type the key to goto that pane)
<prefix> { (Move the current pane left)
<prefix> } (Move the current pane right)
<prefix> z toggle pane zoom

Sync Panes

You can do this by switching to the appropriate window, typing your Tmux prefix (commonly Ctrl-B or Ctrl-A) and then a colon to bring up a Tmux command line, and typing:

:setw synchronize-panes

You can optionally add on or off to specify which state you want; otherwise the option is simply toggled. This option is specific to one window, so it won’t change the way your other sessions or windows operate. When you’re done, toggle it off again by repeating the command. tip source

Resizing Panes

You can also resize panes if you don’t like the layout defaults. I personally rarely need to do this, though it’s handy to know how. Here is the basic syntax to resize panes:

PREFIX : resize-pane -D (Resizes the current pane down)
PREFIX : resize-pane -U (Resizes the current pane upward)
PREFIX : resize-pane -L (Resizes the current pane left)
PREFIX : resize-pane -R (Resizes the current pane right)
PREFIX : resize-pane -D 20 (Resizes the current pane down by 20 cells)
PREFIX : resize-pane -U 20 (Resizes the current pane upward by 20 cells)
PREFIX : resize-pane -L 20 (Resizes the current pane left by 20 cells)
PREFIX : resize-pane -R 20 (Resizes the current pane right by 20 cells)
PREFIX : resize-pane -t 2 20 (Resizes the pane with the id of 2 down by 20 cells)
PREFIX : resize-pane -t -L 20 (Resizes the pane with the id of 2 left by 20 cells)

Copy mode:

Pressing PREFIX [ places us in Copy mode. We can then use our movement keys to move our cursor around the screen. By default, the arrow keys work. we set our configuration file to use Vim keys for moving between windows and resizing panes so we wouldn’t have to take our hands off the home row. tmux has a vi mode for working with the buffer as well. To enable it, add this line to .tmux.conf:

setw -g mode-keys vi

With this option set, we can use h, j, k, and l to move around our buffer.

To get out of Copy mode, we just press the ENTER key. Moving around one character at a time isn’t very efficient. Since we enabled vi mode, we can also use some other visible shortcuts to move around the buffer.

For example, we can use "w" to jump to the next word and "b" to jump back one word. And we can use "f", followed by any character, to jump to that character on the same line, and "F" to jump backwards on the line.

   Function                vi             emacs
   Back to indentation     ^              M-m
   Clear selection         Escape         C-g
   Copy selection          Enter          M-w
   Cursor down             j              Down
   Cursor left             h              Left
   Cursor right            l              Right
   Cursor to bottom line   L
   Cursor to middle line   M              M-r
   Cursor to top line      H              M-R
   Cursor up               k              Up
   Delete entire line      d              C-u
   Delete to end of line   D              C-k
   End of line             $              C-e
   Goto line               :              g
   Half page down          C-d            M-Down
   Half page up            C-u            M-Up
   Next page               C-f            Page down
   Next word               w              M-f
   Paste buffer            p              C-y
   Previous page           C-b            Page up
   Previous word           b              M-b
   Quit mode               q              Escape
   Scroll down             C-Down or J    C-Down
   Scroll up               C-Up or K      C-Up
   Search again            n              n
   Search backward         ?              C-r
   Search forward          /              C-s
   Start of line           0              C-a
   Start selection         Space          C-Space
   Transpose chars                        C-t

Misc

d  detach
t  big clock
?  list shortcuts
:  prompt

Configurations Options:

# Mouse support - set to on if you want to use the mouse
* setw -g mode-mouse off
* set -g mouse-select-pane off
* set -g mouse-resize-pane off
* set -g mouse-select-window off

# Set the default terminal mode to 256color mode
set -g default-terminal "screen-256color"

# enable activity alerts
setw -g monitor-activity on
set -g visual-activity on

# Center the window list
set -g status-justify centre

# Maximize and restore a pane
unbind Up bind Up new-window -d -n tmp \; swap-pane -s tmp.1 \; select-window -t tmp
unbind Down
bind Down last-window \; swap-pane -s tmp.1 \; kill-window -t tmp

TMUX Cheat Sheet References

AUTHORS

Written by Ronald Record [email protected]

LICENSING

ASCIISPLASH-TMUX is distributed under an Open Source license. See the file LICENSE in the ASCIISPLASH-TMUX source distribution for information on terms & conditions for accessing and otherwise using ASCIISPLASH-TMUX and for a DISCLAIMER OF ALL WARRANTIES.

BUGS

Submit bug reports online at:

https://github.com/doctorfree/Asciiville/issues

SEE ALSO

asciijulia(1), asciimpplus(1), asciiplasma(1), asciisplash(1), asciiville(1)

Full documentation and sources at:

https://github.com/doctorfree/Asciiville