Package: tmuxomatic
A completely different kind of tmux session manager.IntroductionLearn by
exampleFlex… ( i.Concepts,
ii.Demo
#1,
iii.Demo
#2)Installation… ( i.Requirements,
ii.Guide,
iii.Optional
packages)Notes on
tmuxContributor
agreementLegal… ( i.Copyright, ii.License)IntroductionOther tmux session managers require pages of documentation for basic
use, and define windows as a complicated nesting of pane splits.
Instead, tmuxomatic is so easy that anyone could use it after just one
example. Yet tmuxomatic is more flexible and more powerful than other
tmux session managers.At the heart of tmuxomatic is thewindowgram, a better way of
arranging tmux windows. The windowgram is a rectangle comprised of
alphanumeric characters (0-9, a-z, A-Z). Each character grouping
identifies the name, position, size, and shape of a pane. It should take
only one example to demonstrate the power and flexibility of the
windowgram.Learn by exampleCompare this window fromsession_example, with its screenshot fromtmuxomatic session_example:window example_one        # A new window begins like this, spaces in names allowed

AAAAAAvvvvvXXXXXTTTT      # The windowgram, defines the shapes and positions of panes
jjjQQQQQQQuuuuuuTTTT      # Make your own, any size and arrangement, 62 panes maximum
jjjQQQQQQQuuuuuuTTTT
jjjQQQQQQQuuuuuuTTTT
0000llllllllllaaaaaa
1234llllllllllaaaaaa

  foc                     # Only three 3-letter commands: Focus, Directory, Run
  dir ~                   # Unlinked directory is the default for all undefined panes
A run figlet "A"          # Linked command to pane A, in this case prints a large "A"
Q run figlet "Q"
A focWith tmuxomatic, you’ll never have to manually split, position, or size
a pane again. And linking the panes to actions is so simple and logical
that you probably won’t forget it. There are no extra file format rules
to remember, and typically no command line arguments will be necessary.For additional features, see the included example sessions. Or for a
list of command line arguments, runtmuxomatic--help.FlexWindowgrams are a neat way of arranging workspaces. For simpler layouts,
a windowgram is typed up quickly. But if you need detail, you may find
yourself doing a lot of ASCII art.In tmuxomatic 2,flexwas added to automate the construction and
modification of the windowgram itself.Flex is an object-oriented windowgram editor. It is visually expressive,
naturally worded, logically ordered, minimal, and powerful. Its short
command set may be combined to make any conceivable windowgram – likely
more quickly and more easily than crafting by hand. Flex is intended for
power users who desire detailed windowgrams without the tedium of manual
entry.Flex conceptsBefore proceeding with the flex demonstration, take a moment to review
the following key concepts.Pane: Single character pane identifier representing one pane in a
windowgramGroup: String of one or more panes (usually in the form of a
rectangle without gaps)Edge: String of panes that together border one or more edges (the
imaginary line between panes)Size: Expressed in exact characters, or contextually as a
percentage or multiplierDirection: Cardinal directions (up, down, left, right) for
movement or to specify object edgeIn the demonstrations below, the flex shell is represented by theflex>prompt. For a detailed list of all flex commands, typehelpfrom the shell at any time.Flex demonstration #1 – Create a new windowgramLet’s use flex to build a windowgram that would otherwise require a lot
of typing.The following windowgram is what we will be creating in this
demonstration. This windowgram is intended for managing cryptocurrency
nodes, specifically bitcoin, litecoin, and namecoin. There are panes for
a general use shell (1), a disk monitor (z); and for each
currency: a title with keep-alive loop on top (B,L,N), and
blockchain information on bottom (b,l,n).1111111111111111111111111zzzzzzzzzzzz
1111111111111111111111111zzzzzzzzzzzz
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111bbbbllllnnnn
1111111111111111111111111bbbbllllnnnn
1111111111111111111111111bbbbllllnnnn
1111111111111111111111111bbbbllllnnnnBegin by opening the flex shell on the session filesession_flexample. Flex will create the session file for you if it
does not already exist.% tmuxomatic session_flexample --flex

flex>First use thenewcommand to create a new window namedwallets.
By default, it will create a single pane window represented by the
single character1.flex> new wallets

1From here it takes only four flex commands to complete the envisioned
windowgram.Scale:To make the window easier to work with, let’sscalethis windowgram
to25characters wide, by10characters high. Many flex
parameters are flexible, instead of characters we could have used
multipliers or percentages.flex> scale 25x10

1111111111111111111111111
1111111111111111111111111
1111111111111111111111111
1111111111111111111111111
1111111111111111111111111
1111111111111111111111111
1111111111111111111111111
1111111111111111111111111
1111111111111111111111111
1111111111111111111111111Add:Now let’sadda new pane on therightedge, and make it50%of the size of the base windowgram (or12characters, if you
prefer).flex> add right 50%

1111111111111111111111111000000000000
1111111111111111111111111000000000000
1111111111111111111111111000000000000
1111111111111111111111111000000000000
1111111111111111111111111000000000000
1111111111111111111111111000000000000
1111111111111111111111111000000000000
1111111111111111111111111000000000000
1111111111111111111111111000000000000
1111111111111111111111111000000000000There are only two commands left to complete this, and two ways to do
it. One way usessplitandbreak, the other usesbreakandjoin. We’ll use break and join, because split is shown in the next
demonstration.Break:So let’sbreakpane0into a grid,3panes wide by5panes high. For readability, we’ll make use of the optional parameter so
that new panes to start atA.flex> break 0 3x5 A

1111111111111111111111111AAAABBBBCCCC
1111111111111111111111111AAAABBBBCCCC
1111111111111111111111111DDDDEEEEFFFF
1111111111111111111111111DDDDEEEEFFFF
1111111111111111111111111GGGGHHHHIIII
1111111111111111111111111GGGGHHHHIIII
1111111111111111111111111JJJJKKKKLLLL
1111111111111111111111111JJJJKKKKLLLL
1111111111111111111111111MMMMNNNNOOOO
1111111111111111111111111MMMMNNNNOOOOJoin:Finally we complete the envisioned layout using just onejoincommand. Each parameter represents a group of panes to be joined
together. By default, the first pane in the group becomes the joined
name. But we’ll be using the optional rename, by appending.followed by the new pane id.flex> join ABC.z DG.B EH.L FI.N JM.b KN.l LO.n

1111111111111111111111111zzzzzzzzzzzz
1111111111111111111111111zzzzzzzzzzzz
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111bbbbllllnnnn
1111111111111111111111111bbbbllllnnnn
1111111111111111111111111bbbbllllnnnn
1111111111111111111111111bbbbllllnnnnThat’s it. Our windowgram is ready to use.Either typedoneand flex will open this session file in tmux, or
typeexitand add some directions to the session file. The
directions specify run commands, home directories, and focus state. For
more information on directions, see the example session at the start of
this readme.Flex demonstration #2 – Extend the windowgramFor this demonstration, we modify the windowgram from the previous
demonstration, using a different set of flex commands. The commands in
this section are described in summary form.Open the windowgram that we created in the above demonstrationflex> use wallets

1111111111111111111111111zzzzzzzzzzzz
1111111111111111111111111zzzzzzzzzzzz
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111bbbbllllnnnn
1111111111111111111111111bbbbllllnnnn
1111111111111111111111111bbbbllllnnnn
1111111111111111111111111bbbbllllnnnnSplit:Split pane1, alongbottom, exactly3characters, name
the new panesflex> split 1 bottom 3 s

1111111111111111111111111zzzzzzzzzzzz
1111111111111111111111111zzzzzzzzzzzz
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111BBBBLLLLNNNN
1111111111111111111111111bbbbllllnnnn
sssssssssssssssssssssssssbbbbllllnnnn
sssssssssssssssssssssssssbbbbllllnnnn
sssssssssssssssssssssssssbbbbllllnnnnRename:Rename the panesNandn, toDanddrespectivelyflex> rename Nn Dd

1111111111111111111111111zzzzzzzzzzzz
1111111111111111111111111zzzzzzzzzzzz
1111111111111111111111111BBBBLLLLDDDD
1111111111111111111111111BBBBLLLLDDDD
1111111111111111111111111BBBBLLLLDDDD
1111111111111111111111111BBBBLLLLDDDD
1111111111111111111111111bbbblllldddd
sssssssssssssssssssssssssbbbblllldddd
sssssssssssssssssssssssssbbbblllldddd
sssssssssssssssssssssssssbbbbllllddddSwap:Swap panezwiths, also swap panesLlwithDd.flex> swap z s Ll Dd

1111111111111111111111111ssssssssssss
1111111111111111111111111ssssssssssss
1111111111111111111111111BBBBDDDDLLLL
1111111111111111111111111BBBBDDDDLLLL
1111111111111111111111111BBBBDDDDLLLL
1111111111111111111111111BBBBDDDDLLLL
1111111111111111111111111bbbbddddllll
zzzzzzzzzzzzzzzzzzzzzzzzzbbbbddddllll
zzzzzzzzzzzzzzzzzzzzzzzzzbbbbddddllll
zzzzzzzzzzzzzzzzzzzzzzzzzbbbbddddllllDrag:Drag theleftedge of groupBDLbdl, to theleft, about50%of the available space.flex> drag left BDLbdl left 50%

1111111111111ssssssssssssssssssssssss
1111111111111ssssssssssssssssssssssss
1111111111111BBBBBBBBDDDDDDDDLLLLLLLL
1111111111111BBBBBBBBDDDDDDDDLLLLLLLL
1111111111111BBBBBBBBDDDDDDDDLLLLLLLL
1111111111111BBBBBBBBDDDDDDDDLLLLLLLL
1111111111111bbbbbbbbddddddddllllllll
zzzzzzzzzzzzzbbbbbbbbddddddddllllllll
zzzzzzzzzzzzzbbbbbbbbddddddddllllllll
zzzzzzzzzzzzzbbbbbbbbddddddddllllllllInsert:Insert to theleftof panes(scaling groupBDLbdl), a
pane6characters wide.flex> insert left s:BDLbdl 6

1111111111111000000ssssssssssssssssssssssss
1111111111111000000ssssssssssssssssssssssss
1111111111111BBBBBBBBBBDDDDDDDDDDLLLLLLLLLL
1111111111111BBBBBBBBBBDDDDDDDDDDLLLLLLLLLL
1111111111111BBBBBBBBBBDDDDDDDDDDLLLLLLLLLL
1111111111111BBBBBBBBBBDDDDDDDDDDLLLLLLLLLL
1111111111111bbbbbbbbbbddddddddddllllllllll
zzzzzzzzzzzzzbbbbbbbbbbddddddddddllllllllll
zzzzzzzzzzzzzbbbbbbbbbbddddddddddllllllllll
zzzzzzzzzzzzzbbbbbbbbbbddddddddddllllllllllClone:Delete:Mirror:Flip:Rotate:Flex is in development, these commands will be added in 2.xInstallationInstallation RequirementsThis application requires the following:Python 3+tmux 1.8+Installation GuideThere are three ways to install tmuxomatic, in order of convenience:Automatically(pip)An upgrade may require an empty pip cache,rm-rf/tmp/pip-build-root/pip-python3install tmuxomatic--upgradeManually(python)Download and extract the archive file fromhttps://pypi.python.org/pypi/tmuxomaticcd tmuxomaticpython3 setup.py installFrom Development(git)Visithttps://github.com/oxidane/tmuxomaticfor up-to-date
installation instructionsAdditional requirement for buildpandoc
1.12+git clonegit://github.com/oxidane/tmuxomatic.gitcd tmuxomaticpandoc-fmarkdown-trst README.md-oREADME.rstpython3 setup.py installVerify that the version reported bytmuxomatic-Vmatches the latest
release.Optional PackagesThe following packages are optional; install if you want the additional
features.pip-python3install pyyaml… YAML session file supportNotes on tmuxTo use tmuxomatic, you don’t have to know everything abouthow to use
tmux,
but the knowledge is useful forcustomizing the tmux status
bar, orchanging the default key
bindings.
These are tmux user preferences, and typically placed in a personal.tmux.conffile.Contributor agreementContributions must be comprised of original source, and/or properly
attributed public domain source. By submitting, you agree that your
contribution will inherit the current copyright and license, and will be
subject to future changes in tmuxomatic and any officially-related
projects.LegalBy downloading, copying, installing or using the software you agree to
the license. If you do not agree to the license, do not download, copy,
install, or use the software.CopyrightCopyright 2013-2015, Oxidane. All rights reserved.LicenseThewindowgrammodule is presently not licensed for use outside the
tmuxomatic project. For more information, including future plans for an
open source license, please see the filewindowgram.py.Thetmuxomaticsource is distributed under theBSD 3-Clause
License. The copyright
and license must be included with any use, modification, or
redistribution. See the license for details.