History log of /openbsd-current/usr.bin/tmux/cmd-save-buffer.c
Revision (<<< Hide revision tags) (Show revision tags >>>) Date Author Comments
# 1.55 07-Dec-2022 nicm

Process escape sequences in show-buffer, GitHub issue 3401.


Revision tags: OPENBSD_7_0_BASE OPENBSD_7_1_BASE OPENBSD_7_2_BASE
# 1.54 21-Aug-2021 nicm

Add args parsing callback for some future work, currently unused.


# 1.53 20-Aug-2021 nicm

Hide struct args behind a couple of accessor functions.


Revision tags: OPENBSD_6_9_BASE
# 1.52 11-Feb-2021 nicm

O_TRUNC is needed in case file exists.


Revision tags: OPENBSD_6_8_BASE
# 1.51 21-Jul-2020 nicm

Fix show-buffer when run from inside tmux, GitHub issue 2314.


Revision tags: OPENBSD_6_7_BASE
# 1.50 13-Apr-2020 nicm

Make client -c and -t handling common in cmd-queue.c and try to be
clearer about whether the client is the target client (must have a
session) or not.


# 1.49 13-Apr-2020 nicm

Also move cmdq_item and cmdq_list into cmd-queue.c (this is to make its
use more clearly defined and preparation for some future work).


# 1.48 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.47 12-Dec-2019 nicm

Rewrite the code for reading and writing files. Now, if the client is
not attached, the server process asks it to open the file, similar to
how works for stdin, stdout, stderr. This makes special files like
/dev/fd/X work (used by some shells). stdin, stdout and stderr and
control mode are now just special cases of the same mechanism. This will
also make it easier to use for other commands that read files such as
source-file.


Revision tags: OPENBSD_6_6_BASE
# 1.46 13-Jun-2019 nicm

Use the right client when working out where to save or load the buffer,
reported by kn@.


Revision tags: OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.45 31-Jul-2018 nicm

Do not leak path or use it after free.


# 1.44 11-Jul-2018 nicm

Expand formats in load-buffer and save-buffer.


Revision tags: OPENBSD_6_2_BASE OPENBSD_6_3_BASE
# 1.43 22-Apr-2017 nicm

Memory leaks, from David CARLIER.


Revision tags: OPENBSD_6_1_BASE
# 1.42 14-Feb-2017 nicm

Make source-file look for files relative to the client working directory
(like load-buffer and save-buffer), from Chris Pickel. Also break the
where-is-this-file code out into its own function for loadb and saveb.


# 1.41 06-Jan-2017 nicm

Nits found with clang.


# 1.40 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.39 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.38 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


Revision tags: OPENBSD_6_0_BASE
# 1.37 05-Mar-2016 nicm

Do not use c->cwd or s->cwd if it is NULL, found by Ben Boeckel.


Revision tags: OPENBSD_5_9_BASE
# 1.36 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.35 13-Dec-2015 nicm

Instead of every command resolving the target (-t or -s) itself, prepare
the state (client, session, winlink, pane) for it it before entering the
command. Each command provides some flags that tell the prepare step
what it is expecting.

This is a requirement for having hooks on commands (for example, if you
hook "select-window -t1:2", the hook command should to operate on window
1:2 not whatever it thinks is the current window), and should allow some
other target improvements.

The old cmd_find_* functions remain for the moment but that layer will
be dropped later.

Joint work with Thomas Adam.


# 1.34 14-Nov-2015 nicm

Push stdout and stderr to clients more aggressively, and add an event to
continue if the send fails.


# 1.33 10-Nov-2015 nicm

If realpath() fails just try the original path.


# 1.32 10-Nov-2015 nicm

Handle absolute paths properly, and don't use resolved path in
realpath() fails.


# 1.31 31-Oct-2015 nicm

Because pledge(2) does not allow us to pass directory file descriptors
around, we can't use file descriptors for the working directory because
we will be unable to pass it to a privileged process to tell it where to
read or write files or spawn children. So move tmux back to using
strings for the current working directory. We try to check it exists
with access() when it is set but ultimately fall back to ~ if it fails
at time of use (or / if that fails too).


# 1.30 29-Aug-2015 nicm

paste_send_pane can be merged into cmd-paste-buffer.c now.


# 1.29 29-Aug-2015 nicm

Move struct paste_buffer out of tmux.h.


Revision tags: OPENBSD_5_8_BASE
# 1.28 27-Apr-2015 nicm

Rewrite of the target resolution internals to be simpler and more
consistent but with much less duplication, but keeping the same internal
API. Also adds more readable aliases for some of the special tokens used
in targets (eg "{start}" instead of "^"). Some behaviours may have
changed, for example prefix matches now happen before fnmatch.


Revision tags: OPENBSD_5_7_BASE
# 1.27 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


# 1.26 08-Oct-2014 nicm

Add xreallocarray and remove nmemb argument from xrealloc.


Revision tags: OPENBSD_5_6_BASE
# 1.25 13-May-2014 nicm

Add support for named buffers. If you don't name a buffer, things work
much as before - buffers are automatically named "buffer0000",
"buffer0001" and so on and ordered as a stack. Buffers can be named
explicitly when creating ("loadb -b foo" etc) or renamed ("setb -b
buffer0000 -n foo"). If buffers are named explicitly, they are not
deleted when buffer-limit is reached. Diff from J Raynor.


# 1.24 24-Apr-2014 nicm

There is no longer a need for a paste_stack struct or for global_buffers
to be global. Move to paste.c.


# 1.23 16-Apr-2014 nicm

Memory leak in error path and unnecessary assignment, from clang.


# 1.22 07-Apr-2014 nicm

save-buffer needs to use O_TRUNC.


Revision tags: OPENBSD_5_5_BASE
# 1.21 10-Oct-2013 nicm

Alter how tmux handles the working directory to internally use file
descriptors rather than strings.

- Each session still has a current working directory.

- New sessions still get their working directory from the client that
created them or its attached session if any.

- New windows are created by default in the session working directory.

- The -c flag to new, neww, splitw allows the working directory to be
overridden.

- The -c flag to attach let's the session working directory be changed.

- The default-path option has been removed.

To get the equivalent to default-path '.', do:

bind c neww -c $PWD

To get the equivalent of default-path '~', do:

bind c neww -c ~

This also changes the client identify protocol to be a set of messages rather
than one as well as some other changes that should make it easier to make
backwards-compatible protocol changes in future.


# 1.20 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.19 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.18 24-Mar-2013 nicm

Merge show-buffer into save-buffer.


# 1.17 22-Mar-2013 nicm

Fix so capture-pane/save-buffer can work in control clients, from George
Nachman.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.16 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.15 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


# 1.14 21-May-2012 nicm

Instead of passing stdin/stdout/stderr file descriptors over imsg and
handling them in the server, handle them in the client and pass buffers
over imsg. This is much tidier for some upcoming changes and the
performance hit isn't critical.

The tty fd is still passed to the server as before.

This bumps the tmux protocol version so new clients and old servers are
incompatible.


# 1.13 21-Mar-2012 nicm

Fix save-buffer usage, from Kazuhiko Sakaguchi.


Revision tags: OPENBSD_5_1_BASE
# 1.12 23-Oct-2011 nicm

Try to resolve relative paths for loadb and saveb (first using client
working directory if any then default-path or session wd).


# 1.11 23-Oct-2011 nicm

Plug a memory leak and update some comments, from Tiago Cunha.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


# 1.9 30-Dec-2010 nicm

Change from a per-session stack of buffers to one global stack which is
much more convenient and also simplifies lot of code. This renders
copy-buffer useless and makes buffer-limit now a server option.

By Tiago Cunha.


Revision tags: OPENBSD_4_8_BASE
# 1.8 24-Jul-2010 nicm

When changing so that the client passes its stdout and stderr as well as
stdin up to the server, I forgot one essential point - the tmux server
could now be both the producer and consumer. This happens when tmux is
run inside tmux, as well as when piping tmux commands together.

So, using stdio(3) was a bad idea - if sufficient data was written, this
could block in write(2). When that happened and the server was both
producer and consumer, it deadlocks.

Change to use libevent bufferevents for the client stdin, stdout and
stderr instead. This is trivial enough for output but requires a
callback mechanism to trigger when stdin is finished.

This relies on the underlying polling mechanism for libevent to work
with whatever devices to which the user could redirect stdin, stdout or
stderr, hence the change to use poll(2) over kqueue(2) for tmux.


# 1.7 28-Jun-2010 nicm

Send all three of stdin, stdout, stderr from the client to the server, so that
commands can directly make use of them. This means that load-buffer and
save-buffer can have "-" as the file to read from stdin or write to stdout.

This is a protocol version bump so the tmux server will need to be restarted
after upgrade (or an older client used).


Revision tags: OPENBSD_4_7_BASE
# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 26-Oct-2009 nicm

Reset the umask right after fopen to avoid leaving it changed on error, noticed
by deraadt@.


# 1.4 07-Sep-2009 nicm

Give each paste buffer a size member instead of requiring them to be
zero-terminated.


# 1.3 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.54 21-Aug-2021 nicm

Add args parsing callback for some future work, currently unused.


# 1.53 20-Aug-2021 nicm

Hide struct args behind a couple of accessor functions.


Revision tags: OPENBSD_6_9_BASE
# 1.52 11-Feb-2021 nicm

O_TRUNC is needed in case file exists.


Revision tags: OPENBSD_6_8_BASE
# 1.51 21-Jul-2020 nicm

Fix show-buffer when run from inside tmux, GitHub issue 2314.


Revision tags: OPENBSD_6_7_BASE
# 1.50 13-Apr-2020 nicm

Make client -c and -t handling common in cmd-queue.c and try to be
clearer about whether the client is the target client (must have a
session) or not.


# 1.49 13-Apr-2020 nicm

Also move cmdq_item and cmdq_list into cmd-queue.c (this is to make its
use more clearly defined and preparation for some future work).


# 1.48 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.47 12-Dec-2019 nicm

Rewrite the code for reading and writing files. Now, if the client is
not attached, the server process asks it to open the file, similar to
how works for stdin, stdout, stderr. This makes special files like
/dev/fd/X work (used by some shells). stdin, stdout and stderr and
control mode are now just special cases of the same mechanism. This will
also make it easier to use for other commands that read files such as
source-file.


Revision tags: OPENBSD_6_6_BASE
# 1.46 13-Jun-2019 nicm

Use the right client when working out where to save or load the buffer,
reported by kn@.


Revision tags: OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.45 31-Jul-2018 nicm

Do not leak path or use it after free.


# 1.44 11-Jul-2018 nicm

Expand formats in load-buffer and save-buffer.


Revision tags: OPENBSD_6_2_BASE OPENBSD_6_3_BASE
# 1.43 22-Apr-2017 nicm

Memory leaks, from David CARLIER.


Revision tags: OPENBSD_6_1_BASE
# 1.42 14-Feb-2017 nicm

Make source-file look for files relative to the client working directory
(like load-buffer and save-buffer), from Chris Pickel. Also break the
where-is-this-file code out into its own function for loadb and saveb.


# 1.41 06-Jan-2017 nicm

Nits found with clang.


# 1.40 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.39 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.38 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


Revision tags: OPENBSD_6_0_BASE
# 1.37 05-Mar-2016 nicm

Do not use c->cwd or s->cwd if it is NULL, found by Ben Boeckel.


Revision tags: OPENBSD_5_9_BASE
# 1.36 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.35 13-Dec-2015 nicm

Instead of every command resolving the target (-t or -s) itself, prepare
the state (client, session, winlink, pane) for it it before entering the
command. Each command provides some flags that tell the prepare step
what it is expecting.

This is a requirement for having hooks on commands (for example, if you
hook "select-window -t1:2", the hook command should to operate on window
1:2 not whatever it thinks is the current window), and should allow some
other target improvements.

The old cmd_find_* functions remain for the moment but that layer will
be dropped later.

Joint work with Thomas Adam.


# 1.34 14-Nov-2015 nicm

Push stdout and stderr to clients more aggressively, and add an event to
continue if the send fails.


# 1.33 10-Nov-2015 nicm

If realpath() fails just try the original path.


# 1.32 10-Nov-2015 nicm

Handle absolute paths properly, and don't use resolved path in
realpath() fails.


# 1.31 31-Oct-2015 nicm

Because pledge(2) does not allow us to pass directory file descriptors
around, we can't use file descriptors for the working directory because
we will be unable to pass it to a privileged process to tell it where to
read or write files or spawn children. So move tmux back to using
strings for the current working directory. We try to check it exists
with access() when it is set but ultimately fall back to ~ if it fails
at time of use (or / if that fails too).


# 1.30 29-Aug-2015 nicm

paste_send_pane can be merged into cmd-paste-buffer.c now.


# 1.29 29-Aug-2015 nicm

Move struct paste_buffer out of tmux.h.


Revision tags: OPENBSD_5_8_BASE
# 1.28 27-Apr-2015 nicm

Rewrite of the target resolution internals to be simpler and more
consistent but with much less duplication, but keeping the same internal
API. Also adds more readable aliases for some of the special tokens used
in targets (eg "{start}" instead of "^"). Some behaviours may have
changed, for example prefix matches now happen before fnmatch.


Revision tags: OPENBSD_5_7_BASE
# 1.27 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


# 1.26 08-Oct-2014 nicm

Add xreallocarray and remove nmemb argument from xrealloc.


Revision tags: OPENBSD_5_6_BASE
# 1.25 13-May-2014 nicm

Add support for named buffers. If you don't name a buffer, things work
much as before - buffers are automatically named "buffer0000",
"buffer0001" and so on and ordered as a stack. Buffers can be named
explicitly when creating ("loadb -b foo" etc) or renamed ("setb -b
buffer0000 -n foo"). If buffers are named explicitly, they are not
deleted when buffer-limit is reached. Diff from J Raynor.


# 1.24 24-Apr-2014 nicm

There is no longer a need for a paste_stack struct or for global_buffers
to be global. Move to paste.c.


# 1.23 16-Apr-2014 nicm

Memory leak in error path and unnecessary assignment, from clang.


# 1.22 07-Apr-2014 nicm

save-buffer needs to use O_TRUNC.


Revision tags: OPENBSD_5_5_BASE
# 1.21 10-Oct-2013 nicm

Alter how tmux handles the working directory to internally use file
descriptors rather than strings.

- Each session still has a current working directory.

- New sessions still get their working directory from the client that
created them or its attached session if any.

- New windows are created by default in the session working directory.

- The -c flag to new, neww, splitw allows the working directory to be
overridden.

- The -c flag to attach let's the session working directory be changed.

- The default-path option has been removed.

To get the equivalent to default-path '.', do:

bind c neww -c $PWD

To get the equivalent of default-path '~', do:

bind c neww -c ~

This also changes the client identify protocol to be a set of messages rather
than one as well as some other changes that should make it easier to make
backwards-compatible protocol changes in future.


# 1.20 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.19 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.18 24-Mar-2013 nicm

Merge show-buffer into save-buffer.


# 1.17 22-Mar-2013 nicm

Fix so capture-pane/save-buffer can work in control clients, from George
Nachman.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.16 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.15 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


# 1.14 21-May-2012 nicm

Instead of passing stdin/stdout/stderr file descriptors over imsg and
handling them in the server, handle them in the client and pass buffers
over imsg. This is much tidier for some upcoming changes and the
performance hit isn't critical.

The tty fd is still passed to the server as before.

This bumps the tmux protocol version so new clients and old servers are
incompatible.


# 1.13 21-Mar-2012 nicm

Fix save-buffer usage, from Kazuhiko Sakaguchi.


Revision tags: OPENBSD_5_1_BASE
# 1.12 23-Oct-2011 nicm

Try to resolve relative paths for loadb and saveb (first using client
working directory if any then default-path or session wd).


# 1.11 23-Oct-2011 nicm

Plug a memory leak and update some comments, from Tiago Cunha.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


# 1.9 30-Dec-2010 nicm

Change from a per-session stack of buffers to one global stack which is
much more convenient and also simplifies lot of code. This renders
copy-buffer useless and makes buffer-limit now a server option.

By Tiago Cunha.


Revision tags: OPENBSD_4_8_BASE
# 1.8 24-Jul-2010 nicm

When changing so that the client passes its stdout and stderr as well as
stdin up to the server, I forgot one essential point - the tmux server
could now be both the producer and consumer. This happens when tmux is
run inside tmux, as well as when piping tmux commands together.

So, using stdio(3) was a bad idea - if sufficient data was written, this
could block in write(2). When that happened and the server was both
producer and consumer, it deadlocks.

Change to use libevent bufferevents for the client stdin, stdout and
stderr instead. This is trivial enough for output but requires a
callback mechanism to trigger when stdin is finished.

This relies on the underlying polling mechanism for libevent to work
with whatever devices to which the user could redirect stdin, stdout or
stderr, hence the change to use poll(2) over kqueue(2) for tmux.


# 1.7 28-Jun-2010 nicm

Send all three of stdin, stdout, stderr from the client to the server, so that
commands can directly make use of them. This means that load-buffer and
save-buffer can have "-" as the file to read from stdin or write to stdout.

This is a protocol version bump so the tmux server will need to be restarted
after upgrade (or an older client used).


Revision tags: OPENBSD_4_7_BASE
# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 26-Oct-2009 nicm

Reset the umask right after fopen to avoid leaving it changed on error, noticed
by deraadt@.


# 1.4 07-Sep-2009 nicm

Give each paste buffer a size member instead of requiring them to be
zero-terminated.


# 1.3 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.52 11-Feb-2021 nicm

O_TRUNC is needed in case file exists.


Revision tags: OPENBSD_6_8_BASE
# 1.51 21-Jul-2020 nicm

Fix show-buffer when run from inside tmux, GitHub issue 2314.


Revision tags: OPENBSD_6_7_BASE
# 1.50 13-Apr-2020 nicm

Make client -c and -t handling common in cmd-queue.c and try to be
clearer about whether the client is the target client (must have a
session) or not.


# 1.49 13-Apr-2020 nicm

Also move cmdq_item and cmdq_list into cmd-queue.c (this is to make its
use more clearly defined and preparation for some future work).


# 1.48 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.47 12-Dec-2019 nicm

Rewrite the code for reading and writing files. Now, if the client is
not attached, the server process asks it to open the file, similar to
how works for stdin, stdout, stderr. This makes special files like
/dev/fd/X work (used by some shells). stdin, stdout and stderr and
control mode are now just special cases of the same mechanism. This will
also make it easier to use for other commands that read files such as
source-file.


Revision tags: OPENBSD_6_6_BASE
# 1.46 13-Jun-2019 nicm

Use the right client when working out where to save or load the buffer,
reported by kn@.


Revision tags: OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.45 31-Jul-2018 nicm

Do not leak path or use it after free.


# 1.44 11-Jul-2018 nicm

Expand formats in load-buffer and save-buffer.


Revision tags: OPENBSD_6_2_BASE OPENBSD_6_3_BASE
# 1.43 22-Apr-2017 nicm

Memory leaks, from David CARLIER.


Revision tags: OPENBSD_6_1_BASE
# 1.42 14-Feb-2017 nicm

Make source-file look for files relative to the client working directory
(like load-buffer and save-buffer), from Chris Pickel. Also break the
where-is-this-file code out into its own function for loadb and saveb.


# 1.41 06-Jan-2017 nicm

Nits found with clang.


# 1.40 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.39 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.38 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


Revision tags: OPENBSD_6_0_BASE
# 1.37 05-Mar-2016 nicm

Do not use c->cwd or s->cwd if it is NULL, found by Ben Boeckel.


Revision tags: OPENBSD_5_9_BASE
# 1.36 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.35 13-Dec-2015 nicm

Instead of every command resolving the target (-t or -s) itself, prepare
the state (client, session, winlink, pane) for it it before entering the
command. Each command provides some flags that tell the prepare step
what it is expecting.

This is a requirement for having hooks on commands (for example, if you
hook "select-window -t1:2", the hook command should to operate on window
1:2 not whatever it thinks is the current window), and should allow some
other target improvements.

The old cmd_find_* functions remain for the moment but that layer will
be dropped later.

Joint work with Thomas Adam.


# 1.34 14-Nov-2015 nicm

Push stdout and stderr to clients more aggressively, and add an event to
continue if the send fails.


# 1.33 10-Nov-2015 nicm

If realpath() fails just try the original path.


# 1.32 10-Nov-2015 nicm

Handle absolute paths properly, and don't use resolved path in
realpath() fails.


# 1.31 31-Oct-2015 nicm

Because pledge(2) does not allow us to pass directory file descriptors
around, we can't use file descriptors for the working directory because
we will be unable to pass it to a privileged process to tell it where to
read or write files or spawn children. So move tmux back to using
strings for the current working directory. We try to check it exists
with access() when it is set but ultimately fall back to ~ if it fails
at time of use (or / if that fails too).


# 1.30 29-Aug-2015 nicm

paste_send_pane can be merged into cmd-paste-buffer.c now.


# 1.29 29-Aug-2015 nicm

Move struct paste_buffer out of tmux.h.


Revision tags: OPENBSD_5_8_BASE
# 1.28 27-Apr-2015 nicm

Rewrite of the target resolution internals to be simpler and more
consistent but with much less duplication, but keeping the same internal
API. Also adds more readable aliases for some of the special tokens used
in targets (eg "{start}" instead of "^"). Some behaviours may have
changed, for example prefix matches now happen before fnmatch.


Revision tags: OPENBSD_5_7_BASE
# 1.27 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


# 1.26 08-Oct-2014 nicm

Add xreallocarray and remove nmemb argument from xrealloc.


Revision tags: OPENBSD_5_6_BASE
# 1.25 13-May-2014 nicm

Add support for named buffers. If you don't name a buffer, things work
much as before - buffers are automatically named "buffer0000",
"buffer0001" and so on and ordered as a stack. Buffers can be named
explicitly when creating ("loadb -b foo" etc) or renamed ("setb -b
buffer0000 -n foo"). If buffers are named explicitly, they are not
deleted when buffer-limit is reached. Diff from J Raynor.


# 1.24 24-Apr-2014 nicm

There is no longer a need for a paste_stack struct or for global_buffers
to be global. Move to paste.c.


# 1.23 16-Apr-2014 nicm

Memory leak in error path and unnecessary assignment, from clang.


# 1.22 07-Apr-2014 nicm

save-buffer needs to use O_TRUNC.


Revision tags: OPENBSD_5_5_BASE
# 1.21 10-Oct-2013 nicm

Alter how tmux handles the working directory to internally use file
descriptors rather than strings.

- Each session still has a current working directory.

- New sessions still get their working directory from the client that
created them or its attached session if any.

- New windows are created by default in the session working directory.

- The -c flag to new, neww, splitw allows the working directory to be
overridden.

- The -c flag to attach let's the session working directory be changed.

- The default-path option has been removed.

To get the equivalent to default-path '.', do:

bind c neww -c $PWD

To get the equivalent of default-path '~', do:

bind c neww -c ~

This also changes the client identify protocol to be a set of messages rather
than one as well as some other changes that should make it easier to make
backwards-compatible protocol changes in future.


# 1.20 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.19 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.18 24-Mar-2013 nicm

Merge show-buffer into save-buffer.


# 1.17 22-Mar-2013 nicm

Fix so capture-pane/save-buffer can work in control clients, from George
Nachman.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.16 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.15 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


# 1.14 21-May-2012 nicm

Instead of passing stdin/stdout/stderr file descriptors over imsg and
handling them in the server, handle them in the client and pass buffers
over imsg. This is much tidier for some upcoming changes and the
performance hit isn't critical.

The tty fd is still passed to the server as before.

This bumps the tmux protocol version so new clients and old servers are
incompatible.


# 1.13 21-Mar-2012 nicm

Fix save-buffer usage, from Kazuhiko Sakaguchi.


Revision tags: OPENBSD_5_1_BASE
# 1.12 23-Oct-2011 nicm

Try to resolve relative paths for loadb and saveb (first using client
working directory if any then default-path or session wd).


# 1.11 23-Oct-2011 nicm

Plug a memory leak and update some comments, from Tiago Cunha.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


# 1.9 30-Dec-2010 nicm

Change from a per-session stack of buffers to one global stack which is
much more convenient and also simplifies lot of code. This renders
copy-buffer useless and makes buffer-limit now a server option.

By Tiago Cunha.


Revision tags: OPENBSD_4_8_BASE
# 1.8 24-Jul-2010 nicm

When changing so that the client passes its stdout and stderr as well as
stdin up to the server, I forgot one essential point - the tmux server
could now be both the producer and consumer. This happens when tmux is
run inside tmux, as well as when piping tmux commands together.

So, using stdio(3) was a bad idea - if sufficient data was written, this
could block in write(2). When that happened and the server was both
producer and consumer, it deadlocks.

Change to use libevent bufferevents for the client stdin, stdout and
stderr instead. This is trivial enough for output but requires a
callback mechanism to trigger when stdin is finished.

This relies on the underlying polling mechanism for libevent to work
with whatever devices to which the user could redirect stdin, stdout or
stderr, hence the change to use poll(2) over kqueue(2) for tmux.


# 1.7 28-Jun-2010 nicm

Send all three of stdin, stdout, stderr from the client to the server, so that
commands can directly make use of them. This means that load-buffer and
save-buffer can have "-" as the file to read from stdin or write to stdout.

This is a protocol version bump so the tmux server will need to be restarted
after upgrade (or an older client used).


Revision tags: OPENBSD_4_7_BASE
# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 26-Oct-2009 nicm

Reset the umask right after fopen to avoid leaving it changed on error, noticed
by deraadt@.


# 1.4 07-Sep-2009 nicm

Give each paste buffer a size member instead of requiring them to be
zero-terminated.


# 1.3 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.51 21-Jul-2020 nicm

Fix show-buffer when run from inside tmux, GitHub issue 2314.


Revision tags: OPENBSD_6_7_BASE
# 1.50 13-Apr-2020 nicm

Make client -c and -t handling common in cmd-queue.c and try to be
clearer about whether the client is the target client (must have a
session) or not.


# 1.49 13-Apr-2020 nicm

Also move cmdq_item and cmdq_list into cmd-queue.c (this is to make its
use more clearly defined and preparation for some future work).


# 1.48 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.47 12-Dec-2019 nicm

Rewrite the code for reading and writing files. Now, if the client is
not attached, the server process asks it to open the file, similar to
how works for stdin, stdout, stderr. This makes special files like
/dev/fd/X work (used by some shells). stdin, stdout and stderr and
control mode are now just special cases of the same mechanism. This will
also make it easier to use for other commands that read files such as
source-file.


Revision tags: OPENBSD_6_6_BASE
# 1.46 13-Jun-2019 nicm

Use the right client when working out where to save or load the buffer,
reported by kn@.


Revision tags: OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.45 31-Jul-2018 nicm

Do not leak path or use it after free.


# 1.44 11-Jul-2018 nicm

Expand formats in load-buffer and save-buffer.


Revision tags: OPENBSD_6_2_BASE OPENBSD_6_3_BASE
# 1.43 22-Apr-2017 nicm

Memory leaks, from David CARLIER.


Revision tags: OPENBSD_6_1_BASE
# 1.42 14-Feb-2017 nicm

Make source-file look for files relative to the client working directory
(like load-buffer and save-buffer), from Chris Pickel. Also break the
where-is-this-file code out into its own function for loadb and saveb.


# 1.41 06-Jan-2017 nicm

Nits found with clang.


# 1.40 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.39 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.38 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


Revision tags: OPENBSD_6_0_BASE
# 1.37 05-Mar-2016 nicm

Do not use c->cwd or s->cwd if it is NULL, found by Ben Boeckel.


Revision tags: OPENBSD_5_9_BASE
# 1.36 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.35 13-Dec-2015 nicm

Instead of every command resolving the target (-t or -s) itself, prepare
the state (client, session, winlink, pane) for it it before entering the
command. Each command provides some flags that tell the prepare step
what it is expecting.

This is a requirement for having hooks on commands (for example, if you
hook "select-window -t1:2", the hook command should to operate on window
1:2 not whatever it thinks is the current window), and should allow some
other target improvements.

The old cmd_find_* functions remain for the moment but that layer will
be dropped later.

Joint work with Thomas Adam.


# 1.34 14-Nov-2015 nicm

Push stdout and stderr to clients more aggressively, and add an event to
continue if the send fails.


# 1.33 10-Nov-2015 nicm

If realpath() fails just try the original path.


# 1.32 10-Nov-2015 nicm

Handle absolute paths properly, and don't use resolved path in
realpath() fails.


# 1.31 31-Oct-2015 nicm

Because pledge(2) does not allow us to pass directory file descriptors
around, we can't use file descriptors for the working directory because
we will be unable to pass it to a privileged process to tell it where to
read or write files or spawn children. So move tmux back to using
strings for the current working directory. We try to check it exists
with access() when it is set but ultimately fall back to ~ if it fails
at time of use (or / if that fails too).


# 1.30 29-Aug-2015 nicm

paste_send_pane can be merged into cmd-paste-buffer.c now.


# 1.29 29-Aug-2015 nicm

Move struct paste_buffer out of tmux.h.


Revision tags: OPENBSD_5_8_BASE
# 1.28 27-Apr-2015 nicm

Rewrite of the target resolution internals to be simpler and more
consistent but with much less duplication, but keeping the same internal
API. Also adds more readable aliases for some of the special tokens used
in targets (eg "{start}" instead of "^"). Some behaviours may have
changed, for example prefix matches now happen before fnmatch.


Revision tags: OPENBSD_5_7_BASE
# 1.27 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


# 1.26 08-Oct-2014 nicm

Add xreallocarray and remove nmemb argument from xrealloc.


Revision tags: OPENBSD_5_6_BASE
# 1.25 13-May-2014 nicm

Add support for named buffers. If you don't name a buffer, things work
much as before - buffers are automatically named "buffer0000",
"buffer0001" and so on and ordered as a stack. Buffers can be named
explicitly when creating ("loadb -b foo" etc) or renamed ("setb -b
buffer0000 -n foo"). If buffers are named explicitly, they are not
deleted when buffer-limit is reached. Diff from J Raynor.


# 1.24 24-Apr-2014 nicm

There is no longer a need for a paste_stack struct or for global_buffers
to be global. Move to paste.c.


# 1.23 16-Apr-2014 nicm

Memory leak in error path and unnecessary assignment, from clang.


# 1.22 07-Apr-2014 nicm

save-buffer needs to use O_TRUNC.


Revision tags: OPENBSD_5_5_BASE
# 1.21 10-Oct-2013 nicm

Alter how tmux handles the working directory to internally use file
descriptors rather than strings.

- Each session still has a current working directory.

- New sessions still get their working directory from the client that
created them or its attached session if any.

- New windows are created by default in the session working directory.

- The -c flag to new, neww, splitw allows the working directory to be
overridden.

- The -c flag to attach let's the session working directory be changed.

- The default-path option has been removed.

To get the equivalent to default-path '.', do:

bind c neww -c $PWD

To get the equivalent of default-path '~', do:

bind c neww -c ~

This also changes the client identify protocol to be a set of messages rather
than one as well as some other changes that should make it easier to make
backwards-compatible protocol changes in future.


# 1.20 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.19 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.18 24-Mar-2013 nicm

Merge show-buffer into save-buffer.


# 1.17 22-Mar-2013 nicm

Fix so capture-pane/save-buffer can work in control clients, from George
Nachman.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.16 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.15 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


# 1.14 21-May-2012 nicm

Instead of passing stdin/stdout/stderr file descriptors over imsg and
handling them in the server, handle them in the client and pass buffers
over imsg. This is much tidier for some upcoming changes and the
performance hit isn't critical.

The tty fd is still passed to the server as before.

This bumps the tmux protocol version so new clients and old servers are
incompatible.


# 1.13 21-Mar-2012 nicm

Fix save-buffer usage, from Kazuhiko Sakaguchi.


Revision tags: OPENBSD_5_1_BASE
# 1.12 23-Oct-2011 nicm

Try to resolve relative paths for loadb and saveb (first using client
working directory if any then default-path or session wd).


# 1.11 23-Oct-2011 nicm

Plug a memory leak and update some comments, from Tiago Cunha.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


# 1.9 30-Dec-2010 nicm

Change from a per-session stack of buffers to one global stack which is
much more convenient and also simplifies lot of code. This renders
copy-buffer useless and makes buffer-limit now a server option.

By Tiago Cunha.


Revision tags: OPENBSD_4_8_BASE
# 1.8 24-Jul-2010 nicm

When changing so that the client passes its stdout and stderr as well as
stdin up to the server, I forgot one essential point - the tmux server
could now be both the producer and consumer. This happens when tmux is
run inside tmux, as well as when piping tmux commands together.

So, using stdio(3) was a bad idea - if sufficient data was written, this
could block in write(2). When that happened and the server was both
producer and consumer, it deadlocks.

Change to use libevent bufferevents for the client stdin, stdout and
stderr instead. This is trivial enough for output but requires a
callback mechanism to trigger when stdin is finished.

This relies on the underlying polling mechanism for libevent to work
with whatever devices to which the user could redirect stdin, stdout or
stderr, hence the change to use poll(2) over kqueue(2) for tmux.


# 1.7 28-Jun-2010 nicm

Send all three of stdin, stdout, stderr from the client to the server, so that
commands can directly make use of them. This means that load-buffer and
save-buffer can have "-" as the file to read from stdin or write to stdout.

This is a protocol version bump so the tmux server will need to be restarted
after upgrade (or an older client used).


Revision tags: OPENBSD_4_7_BASE
# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 26-Oct-2009 nicm

Reset the umask right after fopen to avoid leaving it changed on error, noticed
by deraadt@.


# 1.4 07-Sep-2009 nicm

Give each paste buffer a size member instead of requiring them to be
zero-terminated.


# 1.3 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.50 13-Apr-2020 nicm

Make client -c and -t handling common in cmd-queue.c and try to be
clearer about whether the client is the target client (must have a
session) or not.


# 1.49 13-Apr-2020 nicm

Also move cmdq_item and cmdq_list into cmd-queue.c (this is to make its
use more clearly defined and preparation for some future work).


# 1.48 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.47 12-Dec-2019 nicm

Rewrite the code for reading and writing files. Now, if the client is
not attached, the server process asks it to open the file, similar to
how works for stdin, stdout, stderr. This makes special files like
/dev/fd/X work (used by some shells). stdin, stdout and stderr and
control mode are now just special cases of the same mechanism. This will
also make it easier to use for other commands that read files such as
source-file.


Revision tags: OPENBSD_6_6_BASE
# 1.46 13-Jun-2019 nicm

Use the right client when working out where to save or load the buffer,
reported by kn@.


Revision tags: OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.45 31-Jul-2018 nicm

Do not leak path or use it after free.


# 1.44 11-Jul-2018 nicm

Expand formats in load-buffer and save-buffer.


Revision tags: OPENBSD_6_2_BASE OPENBSD_6_3_BASE
# 1.43 22-Apr-2017 nicm

Memory leaks, from David CARLIER.


Revision tags: OPENBSD_6_1_BASE
# 1.42 14-Feb-2017 nicm

Make source-file look for files relative to the client working directory
(like load-buffer and save-buffer), from Chris Pickel. Also break the
where-is-this-file code out into its own function for loadb and saveb.


# 1.41 06-Jan-2017 nicm

Nits found with clang.


# 1.40 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.39 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.38 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


Revision tags: OPENBSD_6_0_BASE
# 1.37 05-Mar-2016 nicm

Do not use c->cwd or s->cwd if it is NULL, found by Ben Boeckel.


Revision tags: OPENBSD_5_9_BASE
# 1.36 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.35 13-Dec-2015 nicm

Instead of every command resolving the target (-t or -s) itself, prepare
the state (client, session, winlink, pane) for it it before entering the
command. Each command provides some flags that tell the prepare step
what it is expecting.

This is a requirement for having hooks on commands (for example, if you
hook "select-window -t1:2", the hook command should to operate on window
1:2 not whatever it thinks is the current window), and should allow some
other target improvements.

The old cmd_find_* functions remain for the moment but that layer will
be dropped later.

Joint work with Thomas Adam.


# 1.34 14-Nov-2015 nicm

Push stdout and stderr to clients more aggressively, and add an event to
continue if the send fails.


# 1.33 10-Nov-2015 nicm

If realpath() fails just try the original path.


# 1.32 10-Nov-2015 nicm

Handle absolute paths properly, and don't use resolved path in
realpath() fails.


# 1.31 31-Oct-2015 nicm

Because pledge(2) does not allow us to pass directory file descriptors
around, we can't use file descriptors for the working directory because
we will be unable to pass it to a privileged process to tell it where to
read or write files or spawn children. So move tmux back to using
strings for the current working directory. We try to check it exists
with access() when it is set but ultimately fall back to ~ if it fails
at time of use (or / if that fails too).


# 1.30 29-Aug-2015 nicm

paste_send_pane can be merged into cmd-paste-buffer.c now.


# 1.29 29-Aug-2015 nicm

Move struct paste_buffer out of tmux.h.


Revision tags: OPENBSD_5_8_BASE
# 1.28 27-Apr-2015 nicm

Rewrite of the target resolution internals to be simpler and more
consistent but with much less duplication, but keeping the same internal
API. Also adds more readable aliases for some of the special tokens used
in targets (eg "{start}" instead of "^"). Some behaviours may have
changed, for example prefix matches now happen before fnmatch.


Revision tags: OPENBSD_5_7_BASE
# 1.27 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


# 1.26 08-Oct-2014 nicm

Add xreallocarray and remove nmemb argument from xrealloc.


Revision tags: OPENBSD_5_6_BASE
# 1.25 13-May-2014 nicm

Add support for named buffers. If you don't name a buffer, things work
much as before - buffers are automatically named "buffer0000",
"buffer0001" and so on and ordered as a stack. Buffers can be named
explicitly when creating ("loadb -b foo" etc) or renamed ("setb -b
buffer0000 -n foo"). If buffers are named explicitly, they are not
deleted when buffer-limit is reached. Diff from J Raynor.


# 1.24 24-Apr-2014 nicm

There is no longer a need for a paste_stack struct or for global_buffers
to be global. Move to paste.c.


# 1.23 16-Apr-2014 nicm

Memory leak in error path and unnecessary assignment, from clang.


# 1.22 07-Apr-2014 nicm

save-buffer needs to use O_TRUNC.


Revision tags: OPENBSD_5_5_BASE
# 1.21 10-Oct-2013 nicm

Alter how tmux handles the working directory to internally use file
descriptors rather than strings.

- Each session still has a current working directory.

- New sessions still get their working directory from the client that
created them or its attached session if any.

- New windows are created by default in the session working directory.

- The -c flag to new, neww, splitw allows the working directory to be
overridden.

- The -c flag to attach let's the session working directory be changed.

- The default-path option has been removed.

To get the equivalent to default-path '.', do:

bind c neww -c $PWD

To get the equivalent of default-path '~', do:

bind c neww -c ~

This also changes the client identify protocol to be a set of messages rather
than one as well as some other changes that should make it easier to make
backwards-compatible protocol changes in future.


# 1.20 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.19 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.18 24-Mar-2013 nicm

Merge show-buffer into save-buffer.


# 1.17 22-Mar-2013 nicm

Fix so capture-pane/save-buffer can work in control clients, from George
Nachman.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.16 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.15 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


# 1.14 21-May-2012 nicm

Instead of passing stdin/stdout/stderr file descriptors over imsg and
handling them in the server, handle them in the client and pass buffers
over imsg. This is much tidier for some upcoming changes and the
performance hit isn't critical.

The tty fd is still passed to the server as before.

This bumps the tmux protocol version so new clients and old servers are
incompatible.


# 1.13 21-Mar-2012 nicm

Fix save-buffer usage, from Kazuhiko Sakaguchi.


Revision tags: OPENBSD_5_1_BASE
# 1.12 23-Oct-2011 nicm

Try to resolve relative paths for loadb and saveb (first using client
working directory if any then default-path or session wd).


# 1.11 23-Oct-2011 nicm

Plug a memory leak and update some comments, from Tiago Cunha.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


# 1.9 30-Dec-2010 nicm

Change from a per-session stack of buffers to one global stack which is
much more convenient and also simplifies lot of code. This renders
copy-buffer useless and makes buffer-limit now a server option.

By Tiago Cunha.


Revision tags: OPENBSD_4_8_BASE
# 1.8 24-Jul-2010 nicm

When changing so that the client passes its stdout and stderr as well as
stdin up to the server, I forgot one essential point - the tmux server
could now be both the producer and consumer. This happens when tmux is
run inside tmux, as well as when piping tmux commands together.

So, using stdio(3) was a bad idea - if sufficient data was written, this
could block in write(2). When that happened and the server was both
producer and consumer, it deadlocks.

Change to use libevent bufferevents for the client stdin, stdout and
stderr instead. This is trivial enough for output but requires a
callback mechanism to trigger when stdin is finished.

This relies on the underlying polling mechanism for libevent to work
with whatever devices to which the user could redirect stdin, stdout or
stderr, hence the change to use poll(2) over kqueue(2) for tmux.


# 1.7 28-Jun-2010 nicm

Send all three of stdin, stdout, stderr from the client to the server, so that
commands can directly make use of them. This means that load-buffer and
save-buffer can have "-" as the file to read from stdin or write to stdout.

This is a protocol version bump so the tmux server will need to be restarted
after upgrade (or an older client used).


Revision tags: OPENBSD_4_7_BASE
# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 26-Oct-2009 nicm

Reset the umask right after fopen to avoid leaving it changed on error, noticed
by deraadt@.


# 1.4 07-Sep-2009 nicm

Give each paste buffer a size member instead of requiring them to be
zero-terminated.


# 1.3 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.49 13-Apr-2020 nicm

Also move cmdq_item and cmdq_list into cmd-queue.c (this is to make its
use more clearly defined and preparation for some future work).


# 1.48 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.47 12-Dec-2019 nicm

Rewrite the code for reading and writing files. Now, if the client is
not attached, the server process asks it to open the file, similar to
how works for stdin, stdout, stderr. This makes special files like
/dev/fd/X work (used by some shells). stdin, stdout and stderr and
control mode are now just special cases of the same mechanism. This will
also make it easier to use for other commands that read files such as
source-file.


Revision tags: OPENBSD_6_6_BASE
# 1.46 13-Jun-2019 nicm

Use the right client when working out where to save or load the buffer,
reported by kn@.


Revision tags: OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.45 31-Jul-2018 nicm

Do not leak path or use it after free.


# 1.44 11-Jul-2018 nicm

Expand formats in load-buffer and save-buffer.


Revision tags: OPENBSD_6_2_BASE OPENBSD_6_3_BASE
# 1.43 22-Apr-2017 nicm

Memory leaks, from David CARLIER.


Revision tags: OPENBSD_6_1_BASE
# 1.42 14-Feb-2017 nicm

Make source-file look for files relative to the client working directory
(like load-buffer and save-buffer), from Chris Pickel. Also break the
where-is-this-file code out into its own function for loadb and saveb.


# 1.41 06-Jan-2017 nicm

Nits found with clang.


# 1.40 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.39 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.38 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


Revision tags: OPENBSD_6_0_BASE
# 1.37 05-Mar-2016 nicm

Do not use c->cwd or s->cwd if it is NULL, found by Ben Boeckel.


Revision tags: OPENBSD_5_9_BASE
# 1.36 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.35 13-Dec-2015 nicm

Instead of every command resolving the target (-t or -s) itself, prepare
the state (client, session, winlink, pane) for it it before entering the
command. Each command provides some flags that tell the prepare step
what it is expecting.

This is a requirement for having hooks on commands (for example, if you
hook "select-window -t1:2", the hook command should to operate on window
1:2 not whatever it thinks is the current window), and should allow some
other target improvements.

The old cmd_find_* functions remain for the moment but that layer will
be dropped later.

Joint work with Thomas Adam.


# 1.34 14-Nov-2015 nicm

Push stdout and stderr to clients more aggressively, and add an event to
continue if the send fails.


# 1.33 10-Nov-2015 nicm

If realpath() fails just try the original path.


# 1.32 10-Nov-2015 nicm

Handle absolute paths properly, and don't use resolved path in
realpath() fails.


# 1.31 31-Oct-2015 nicm

Because pledge(2) does not allow us to pass directory file descriptors
around, we can't use file descriptors for the working directory because
we will be unable to pass it to a privileged process to tell it where to
read or write files or spawn children. So move tmux back to using
strings for the current working directory. We try to check it exists
with access() when it is set but ultimately fall back to ~ if it fails
at time of use (or / if that fails too).


# 1.30 29-Aug-2015 nicm

paste_send_pane can be merged into cmd-paste-buffer.c now.


# 1.29 29-Aug-2015 nicm

Move struct paste_buffer out of tmux.h.


Revision tags: OPENBSD_5_8_BASE
# 1.28 27-Apr-2015 nicm

Rewrite of the target resolution internals to be simpler and more
consistent but with much less duplication, but keeping the same internal
API. Also adds more readable aliases for some of the special tokens used
in targets (eg "{start}" instead of "^"). Some behaviours may have
changed, for example prefix matches now happen before fnmatch.


Revision tags: OPENBSD_5_7_BASE
# 1.27 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


# 1.26 08-Oct-2014 nicm

Add xreallocarray and remove nmemb argument from xrealloc.


Revision tags: OPENBSD_5_6_BASE
# 1.25 13-May-2014 nicm

Add support for named buffers. If you don't name a buffer, things work
much as before - buffers are automatically named "buffer0000",
"buffer0001" and so on and ordered as a stack. Buffers can be named
explicitly when creating ("loadb -b foo" etc) or renamed ("setb -b
buffer0000 -n foo"). If buffers are named explicitly, they are not
deleted when buffer-limit is reached. Diff from J Raynor.


# 1.24 24-Apr-2014 nicm

There is no longer a need for a paste_stack struct or for global_buffers
to be global. Move to paste.c.


# 1.23 16-Apr-2014 nicm

Memory leak in error path and unnecessary assignment, from clang.


# 1.22 07-Apr-2014 nicm

save-buffer needs to use O_TRUNC.


Revision tags: OPENBSD_5_5_BASE
# 1.21 10-Oct-2013 nicm

Alter how tmux handles the working directory to internally use file
descriptors rather than strings.

- Each session still has a current working directory.

- New sessions still get their working directory from the client that
created them or its attached session if any.

- New windows are created by default in the session working directory.

- The -c flag to new, neww, splitw allows the working directory to be
overridden.

- The -c flag to attach let's the session working directory be changed.

- The default-path option has been removed.

To get the equivalent to default-path '.', do:

bind c neww -c $PWD

To get the equivalent of default-path '~', do:

bind c neww -c ~

This also changes the client identify protocol to be a set of messages rather
than one as well as some other changes that should make it easier to make
backwards-compatible protocol changes in future.


# 1.20 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.19 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.18 24-Mar-2013 nicm

Merge show-buffer into save-buffer.


# 1.17 22-Mar-2013 nicm

Fix so capture-pane/save-buffer can work in control clients, from George
Nachman.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.16 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.15 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


# 1.14 21-May-2012 nicm

Instead of passing stdin/stdout/stderr file descriptors over imsg and
handling them in the server, handle them in the client and pass buffers
over imsg. This is much tidier for some upcoming changes and the
performance hit isn't critical.

The tty fd is still passed to the server as before.

This bumps the tmux protocol version so new clients and old servers are
incompatible.


# 1.13 21-Mar-2012 nicm

Fix save-buffer usage, from Kazuhiko Sakaguchi.


Revision tags: OPENBSD_5_1_BASE
# 1.12 23-Oct-2011 nicm

Try to resolve relative paths for loadb and saveb (first using client
working directory if any then default-path or session wd).


# 1.11 23-Oct-2011 nicm

Plug a memory leak and update some comments, from Tiago Cunha.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


# 1.9 30-Dec-2010 nicm

Change from a per-session stack of buffers to one global stack which is
much more convenient and also simplifies lot of code. This renders
copy-buffer useless and makes buffer-limit now a server option.

By Tiago Cunha.


Revision tags: OPENBSD_4_8_BASE
# 1.8 24-Jul-2010 nicm

When changing so that the client passes its stdout and stderr as well as
stdin up to the server, I forgot one essential point - the tmux server
could now be both the producer and consumer. This happens when tmux is
run inside tmux, as well as when piping tmux commands together.

So, using stdio(3) was a bad idea - if sufficient data was written, this
could block in write(2). When that happened and the server was both
producer and consumer, it deadlocks.

Change to use libevent bufferevents for the client stdin, stdout and
stderr instead. This is trivial enough for output but requires a
callback mechanism to trigger when stdin is finished.

This relies on the underlying polling mechanism for libevent to work
with whatever devices to which the user could redirect stdin, stdout or
stderr, hence the change to use poll(2) over kqueue(2) for tmux.


# 1.7 28-Jun-2010 nicm

Send all three of stdin, stdout, stderr from the client to the server, so that
commands can directly make use of them. This means that load-buffer and
save-buffer can have "-" as the file to read from stdin or write to stdout.

This is a protocol version bump so the tmux server will need to be restarted
after upgrade (or an older client used).


Revision tags: OPENBSD_4_7_BASE
# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 26-Oct-2009 nicm

Reset the umask right after fopen to avoid leaving it changed on error, noticed
by deraadt@.


# 1.4 07-Sep-2009 nicm

Give each paste buffer a size member instead of requiring them to be
zero-terminated.


# 1.3 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.47 12-Dec-2019 nicm

Rewrite the code for reading and writing files. Now, if the client is
not attached, the server process asks it to open the file, similar to
how works for stdin, stdout, stderr. This makes special files like
/dev/fd/X work (used by some shells). stdin, stdout and stderr and
control mode are now just special cases of the same mechanism. This will
also make it easier to use for other commands that read files such as
source-file.


Revision tags: OPENBSD_6_6_BASE
# 1.46 13-Jun-2019 nicm

Use the right client when working out where to save or load the buffer,
reported by kn@.


Revision tags: OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.45 31-Jul-2018 nicm

Do not leak path or use it after free.


# 1.44 11-Jul-2018 nicm

Expand formats in load-buffer and save-buffer.


Revision tags: OPENBSD_6_2_BASE OPENBSD_6_3_BASE
# 1.43 22-Apr-2017 nicm

Memory leaks, from David CARLIER.


Revision tags: OPENBSD_6_1_BASE
# 1.42 14-Feb-2017 nicm

Make source-file look for files relative to the client working directory
(like load-buffer and save-buffer), from Chris Pickel. Also break the
where-is-this-file code out into its own function for loadb and saveb.


# 1.41 06-Jan-2017 nicm

Nits found with clang.


# 1.40 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.39 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.38 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


Revision tags: OPENBSD_6_0_BASE
# 1.37 05-Mar-2016 nicm

Do not use c->cwd or s->cwd if it is NULL, found by Ben Boeckel.


Revision tags: OPENBSD_5_9_BASE
# 1.36 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.35 13-Dec-2015 nicm

Instead of every command resolving the target (-t or -s) itself, prepare
the state (client, session, winlink, pane) for it it before entering the
command. Each command provides some flags that tell the prepare step
what it is expecting.

This is a requirement for having hooks on commands (for example, if you
hook "select-window -t1:2", the hook command should to operate on window
1:2 not whatever it thinks is the current window), and should allow some
other target improvements.

The old cmd_find_* functions remain for the moment but that layer will
be dropped later.

Joint work with Thomas Adam.


# 1.34 14-Nov-2015 nicm

Push stdout and stderr to clients more aggressively, and add an event to
continue if the send fails.


# 1.33 10-Nov-2015 nicm

If realpath() fails just try the original path.


# 1.32 10-Nov-2015 nicm

Handle absolute paths properly, and don't use resolved path in
realpath() fails.


# 1.31 31-Oct-2015 nicm

Because pledge(2) does not allow us to pass directory file descriptors
around, we can't use file descriptors for the working directory because
we will be unable to pass it to a privileged process to tell it where to
read or write files or spawn children. So move tmux back to using
strings for the current working directory. We try to check it exists
with access() when it is set but ultimately fall back to ~ if it fails
at time of use (or / if that fails too).


# 1.30 29-Aug-2015 nicm

paste_send_pane can be merged into cmd-paste-buffer.c now.


# 1.29 29-Aug-2015 nicm

Move struct paste_buffer out of tmux.h.


Revision tags: OPENBSD_5_8_BASE
# 1.28 27-Apr-2015 nicm

Rewrite of the target resolution internals to be simpler and more
consistent but with much less duplication, but keeping the same internal
API. Also adds more readable aliases for some of the special tokens used
in targets (eg "{start}" instead of "^"). Some behaviours may have
changed, for example prefix matches now happen before fnmatch.


Revision tags: OPENBSD_5_7_BASE
# 1.27 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


# 1.26 08-Oct-2014 nicm

Add xreallocarray and remove nmemb argument from xrealloc.


Revision tags: OPENBSD_5_6_BASE
# 1.25 13-May-2014 nicm

Add support for named buffers. If you don't name a buffer, things work
much as before - buffers are automatically named "buffer0000",
"buffer0001" and so on and ordered as a stack. Buffers can be named
explicitly when creating ("loadb -b foo" etc) or renamed ("setb -b
buffer0000 -n foo"). If buffers are named explicitly, they are not
deleted when buffer-limit is reached. Diff from J Raynor.


# 1.24 24-Apr-2014 nicm

There is no longer a need for a paste_stack struct or for global_buffers
to be global. Move to paste.c.


# 1.23 16-Apr-2014 nicm

Memory leak in error path and unnecessary assignment, from clang.


# 1.22 07-Apr-2014 nicm

save-buffer needs to use O_TRUNC.


Revision tags: OPENBSD_5_5_BASE
# 1.21 10-Oct-2013 nicm

Alter how tmux handles the working directory to internally use file
descriptors rather than strings.

- Each session still has a current working directory.

- New sessions still get their working directory from the client that
created them or its attached session if any.

- New windows are created by default in the session working directory.

- The -c flag to new, neww, splitw allows the working directory to be
overridden.

- The -c flag to attach let's the session working directory be changed.

- The default-path option has been removed.

To get the equivalent to default-path '.', do:

bind c neww -c $PWD

To get the equivalent of default-path '~', do:

bind c neww -c ~

This also changes the client identify protocol to be a set of messages rather
than one as well as some other changes that should make it easier to make
backwards-compatible protocol changes in future.


# 1.20 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.19 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.18 24-Mar-2013 nicm

Merge show-buffer into save-buffer.


# 1.17 22-Mar-2013 nicm

Fix so capture-pane/save-buffer can work in control clients, from George
Nachman.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.16 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.15 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


# 1.14 21-May-2012 nicm

Instead of passing stdin/stdout/stderr file descriptors over imsg and
handling them in the server, handle them in the client and pass buffers
over imsg. This is much tidier for some upcoming changes and the
performance hit isn't critical.

The tty fd is still passed to the server as before.

This bumps the tmux protocol version so new clients and old servers are
incompatible.


# 1.13 21-Mar-2012 nicm

Fix save-buffer usage, from Kazuhiko Sakaguchi.


Revision tags: OPENBSD_5_1_BASE
# 1.12 23-Oct-2011 nicm

Try to resolve relative paths for loadb and saveb (first using client
working directory if any then default-path or session wd).


# 1.11 23-Oct-2011 nicm

Plug a memory leak and update some comments, from Tiago Cunha.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


# 1.9 30-Dec-2010 nicm

Change from a per-session stack of buffers to one global stack which is
much more convenient and also simplifies lot of code. This renders
copy-buffer useless and makes buffer-limit now a server option.

By Tiago Cunha.


Revision tags: OPENBSD_4_8_BASE
# 1.8 24-Jul-2010 nicm

When changing so that the client passes its stdout and stderr as well as
stdin up to the server, I forgot one essential point - the tmux server
could now be both the producer and consumer. This happens when tmux is
run inside tmux, as well as when piping tmux commands together.

So, using stdio(3) was a bad idea - if sufficient data was written, this
could block in write(2). When that happened and the server was both
producer and consumer, it deadlocks.

Change to use libevent bufferevents for the client stdin, stdout and
stderr instead. This is trivial enough for output but requires a
callback mechanism to trigger when stdin is finished.

This relies on the underlying polling mechanism for libevent to work
with whatever devices to which the user could redirect stdin, stdout or
stderr, hence the change to use poll(2) over kqueue(2) for tmux.


# 1.7 28-Jun-2010 nicm

Send all three of stdin, stdout, stderr from the client to the server, so that
commands can directly make use of them. This means that load-buffer and
save-buffer can have "-" as the file to read from stdin or write to stdout.

This is a protocol version bump so the tmux server will need to be restarted
after upgrade (or an older client used).


Revision tags: OPENBSD_4_7_BASE
# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 26-Oct-2009 nicm

Reset the umask right after fopen to avoid leaving it changed on error, noticed
by deraadt@.


# 1.4 07-Sep-2009 nicm

Give each paste buffer a size member instead of requiring them to be
zero-terminated.


# 1.3 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.46 13-Jun-2019 nicm

Use the right client when working out where to save or load the buffer,
reported by kn@.


Revision tags: OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.45 31-Jul-2018 nicm

Do not leak path or use it after free.


# 1.44 11-Jul-2018 nicm

Expand formats in load-buffer and save-buffer.


Revision tags: OPENBSD_6_2_BASE OPENBSD_6_3_BASE
# 1.43 22-Apr-2017 nicm

Memory leaks, from David CARLIER.


Revision tags: OPENBSD_6_1_BASE
# 1.42 14-Feb-2017 nicm

Make source-file look for files relative to the client working directory
(like load-buffer and save-buffer), from Chris Pickel. Also break the
where-is-this-file code out into its own function for loadb and saveb.


# 1.41 06-Jan-2017 nicm

Nits found with clang.


# 1.40 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.39 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.38 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


Revision tags: OPENBSD_6_0_BASE
# 1.37 05-Mar-2016 nicm

Do not use c->cwd or s->cwd if it is NULL, found by Ben Boeckel.


Revision tags: OPENBSD_5_9_BASE
# 1.36 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.35 13-Dec-2015 nicm

Instead of every command resolving the target (-t or -s) itself, prepare
the state (client, session, winlink, pane) for it it before entering the
command. Each command provides some flags that tell the prepare step
what it is expecting.

This is a requirement for having hooks on commands (for example, if you
hook "select-window -t1:2", the hook command should to operate on window
1:2 not whatever it thinks is the current window), and should allow some
other target improvements.

The old cmd_find_* functions remain for the moment but that layer will
be dropped later.

Joint work with Thomas Adam.


# 1.34 14-Nov-2015 nicm

Push stdout and stderr to clients more aggressively, and add an event to
continue if the send fails.


# 1.33 10-Nov-2015 nicm

If realpath() fails just try the original path.


# 1.32 10-Nov-2015 nicm

Handle absolute paths properly, and don't use resolved path in
realpath() fails.


# 1.31 31-Oct-2015 nicm

Because pledge(2) does not allow us to pass directory file descriptors
around, we can't use file descriptors for the working directory because
we will be unable to pass it to a privileged process to tell it where to
read or write files or spawn children. So move tmux back to using
strings for the current working directory. We try to check it exists
with access() when it is set but ultimately fall back to ~ if it fails
at time of use (or / if that fails too).


# 1.30 29-Aug-2015 nicm

paste_send_pane can be merged into cmd-paste-buffer.c now.


# 1.29 29-Aug-2015 nicm

Move struct paste_buffer out of tmux.h.


Revision tags: OPENBSD_5_8_BASE
# 1.28 27-Apr-2015 nicm

Rewrite of the target resolution internals to be simpler and more
consistent but with much less duplication, but keeping the same internal
API. Also adds more readable aliases for some of the special tokens used
in targets (eg "{start}" instead of "^"). Some behaviours may have
changed, for example prefix matches now happen before fnmatch.


Revision tags: OPENBSD_5_7_BASE
# 1.27 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


# 1.26 08-Oct-2014 nicm

Add xreallocarray and remove nmemb argument from xrealloc.


Revision tags: OPENBSD_5_6_BASE
# 1.25 13-May-2014 nicm

Add support for named buffers. If you don't name a buffer, things work
much as before - buffers are automatically named "buffer0000",
"buffer0001" and so on and ordered as a stack. Buffers can be named
explicitly when creating ("loadb -b foo" etc) or renamed ("setb -b
buffer0000 -n foo"). If buffers are named explicitly, they are not
deleted when buffer-limit is reached. Diff from J Raynor.


# 1.24 24-Apr-2014 nicm

There is no longer a need for a paste_stack struct or for global_buffers
to be global. Move to paste.c.


# 1.23 16-Apr-2014 nicm

Memory leak in error path and unnecessary assignment, from clang.


# 1.22 07-Apr-2014 nicm

save-buffer needs to use O_TRUNC.


Revision tags: OPENBSD_5_5_BASE
# 1.21 10-Oct-2013 nicm

Alter how tmux handles the working directory to internally use file
descriptors rather than strings.

- Each session still has a current working directory.

- New sessions still get their working directory from the client that
created them or its attached session if any.

- New windows are created by default in the session working directory.

- The -c flag to new, neww, splitw allows the working directory to be
overridden.

- The -c flag to attach let's the session working directory be changed.

- The default-path option has been removed.

To get the equivalent to default-path '.', do:

bind c neww -c $PWD

To get the equivalent of default-path '~', do:

bind c neww -c ~

This also changes the client identify protocol to be a set of messages rather
than one as well as some other changes that should make it easier to make
backwards-compatible protocol changes in future.


# 1.20 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.19 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.18 24-Mar-2013 nicm

Merge show-buffer into save-buffer.


# 1.17 22-Mar-2013 nicm

Fix so capture-pane/save-buffer can work in control clients, from George
Nachman.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.16 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.15 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


# 1.14 21-May-2012 nicm

Instead of passing stdin/stdout/stderr file descriptors over imsg and
handling them in the server, handle them in the client and pass buffers
over imsg. This is much tidier for some upcoming changes and the
performance hit isn't critical.

The tty fd is still passed to the server as before.

This bumps the tmux protocol version so new clients and old servers are
incompatible.


# 1.13 21-Mar-2012 nicm

Fix save-buffer usage, from Kazuhiko Sakaguchi.


Revision tags: OPENBSD_5_1_BASE
# 1.12 23-Oct-2011 nicm

Try to resolve relative paths for loadb and saveb (first using client
working directory if any then default-path or session wd).


# 1.11 23-Oct-2011 nicm

Plug a memory leak and update some comments, from Tiago Cunha.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


# 1.9 30-Dec-2010 nicm

Change from a per-session stack of buffers to one global stack which is
much more convenient and also simplifies lot of code. This renders
copy-buffer useless and makes buffer-limit now a server option.

By Tiago Cunha.


Revision tags: OPENBSD_4_8_BASE
# 1.8 24-Jul-2010 nicm

When changing so that the client passes its stdout and stderr as well as
stdin up to the server, I forgot one essential point - the tmux server
could now be both the producer and consumer. This happens when tmux is
run inside tmux, as well as when piping tmux commands together.

So, using stdio(3) was a bad idea - if sufficient data was written, this
could block in write(2). When that happened and the server was both
producer and consumer, it deadlocks.

Change to use libevent bufferevents for the client stdin, stdout and
stderr instead. This is trivial enough for output but requires a
callback mechanism to trigger when stdin is finished.

This relies on the underlying polling mechanism for libevent to work
with whatever devices to which the user could redirect stdin, stdout or
stderr, hence the change to use poll(2) over kqueue(2) for tmux.


# 1.7 28-Jun-2010 nicm

Send all three of stdin, stdout, stderr from the client to the server, so that
commands can directly make use of them. This means that load-buffer and
save-buffer can have "-" as the file to read from stdin or write to stdout.

This is a protocol version bump so the tmux server will need to be restarted
after upgrade (or an older client used).


Revision tags: OPENBSD_4_7_BASE
# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 26-Oct-2009 nicm

Reset the umask right after fopen to avoid leaving it changed on error, noticed
by deraadt@.


# 1.4 07-Sep-2009 nicm

Give each paste buffer a size member instead of requiring them to be
zero-terminated.


# 1.3 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.45 31-Jul-2018 nicm

Do not leak path or use it after free.


# 1.44 11-Jul-2018 nicm

Expand formats in load-buffer and save-buffer.


Revision tags: OPENBSD_6_2_BASE OPENBSD_6_3_BASE
# 1.43 22-Apr-2017 nicm

Memory leaks, from David CARLIER.


Revision tags: OPENBSD_6_1_BASE
# 1.42 14-Feb-2017 nicm

Make source-file look for files relative to the client working directory
(like load-buffer and save-buffer), from Chris Pickel. Also break the
where-is-this-file code out into its own function for loadb and saveb.


# 1.41 06-Jan-2017 nicm

Nits found with clang.


# 1.40 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.39 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.38 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


Revision tags: OPENBSD_6_0_BASE
# 1.37 05-Mar-2016 nicm

Do not use c->cwd or s->cwd if it is NULL, found by Ben Boeckel.


Revision tags: OPENBSD_5_9_BASE
# 1.36 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.35 13-Dec-2015 nicm

Instead of every command resolving the target (-t or -s) itself, prepare
the state (client, session, winlink, pane) for it it before entering the
command. Each command provides some flags that tell the prepare step
what it is expecting.

This is a requirement for having hooks on commands (for example, if you
hook "select-window -t1:2", the hook command should to operate on window
1:2 not whatever it thinks is the current window), and should allow some
other target improvements.

The old cmd_find_* functions remain for the moment but that layer will
be dropped later.

Joint work with Thomas Adam.


# 1.34 14-Nov-2015 nicm

Push stdout and stderr to clients more aggressively, and add an event to
continue if the send fails.


# 1.33 10-Nov-2015 nicm

If realpath() fails just try the original path.


# 1.32 10-Nov-2015 nicm

Handle absolute paths properly, and don't use resolved path in
realpath() fails.


# 1.31 31-Oct-2015 nicm

Because pledge(2) does not allow us to pass directory file descriptors
around, we can't use file descriptors for the working directory because
we will be unable to pass it to a privileged process to tell it where to
read or write files or spawn children. So move tmux back to using
strings for the current working directory. We try to check it exists
with access() when it is set but ultimately fall back to ~ if it fails
at time of use (or / if that fails too).


# 1.30 29-Aug-2015 nicm

paste_send_pane can be merged into cmd-paste-buffer.c now.


# 1.29 29-Aug-2015 nicm

Move struct paste_buffer out of tmux.h.


Revision tags: OPENBSD_5_8_BASE
# 1.28 27-Apr-2015 nicm

Rewrite of the target resolution internals to be simpler and more
consistent but with much less duplication, but keeping the same internal
API. Also adds more readable aliases for some of the special tokens used
in targets (eg "{start}" instead of "^"). Some behaviours may have
changed, for example prefix matches now happen before fnmatch.


Revision tags: OPENBSD_5_7_BASE
# 1.27 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


# 1.26 08-Oct-2014 nicm

Add xreallocarray and remove nmemb argument from xrealloc.


Revision tags: OPENBSD_5_6_BASE
# 1.25 13-May-2014 nicm

Add support for named buffers. If you don't name a buffer, things work
much as before - buffers are automatically named "buffer0000",
"buffer0001" and so on and ordered as a stack. Buffers can be named
explicitly when creating ("loadb -b foo" etc) or renamed ("setb -b
buffer0000 -n foo"). If buffers are named explicitly, they are not
deleted when buffer-limit is reached. Diff from J Raynor.


# 1.24 24-Apr-2014 nicm

There is no longer a need for a paste_stack struct or for global_buffers
to be global. Move to paste.c.


# 1.23 16-Apr-2014 nicm

Memory leak in error path and unnecessary assignment, from clang.


# 1.22 07-Apr-2014 nicm

save-buffer needs to use O_TRUNC.


Revision tags: OPENBSD_5_5_BASE
# 1.21 10-Oct-2013 nicm

Alter how tmux handles the working directory to internally use file
descriptors rather than strings.

- Each session still has a current working directory.

- New sessions still get their working directory from the client that
created them or its attached session if any.

- New windows are created by default in the session working directory.

- The -c flag to new, neww, splitw allows the working directory to be
overridden.

- The -c flag to attach let's the session working directory be changed.

- The default-path option has been removed.

To get the equivalent to default-path '.', do:

bind c neww -c $PWD

To get the equivalent of default-path '~', do:

bind c neww -c ~

This also changes the client identify protocol to be a set of messages rather
than one as well as some other changes that should make it easier to make
backwards-compatible protocol changes in future.


# 1.20 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.19 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.18 24-Mar-2013 nicm

Merge show-buffer into save-buffer.


# 1.17 22-Mar-2013 nicm

Fix so capture-pane/save-buffer can work in control clients, from George
Nachman.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.16 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.15 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


# 1.14 21-May-2012 nicm

Instead of passing stdin/stdout/stderr file descriptors over imsg and
handling them in the server, handle them in the client and pass buffers
over imsg. This is much tidier for some upcoming changes and the
performance hit isn't critical.

The tty fd is still passed to the server as before.

This bumps the tmux protocol version so new clients and old servers are
incompatible.


# 1.13 21-Mar-2012 nicm

Fix save-buffer usage, from Kazuhiko Sakaguchi.


Revision tags: OPENBSD_5_1_BASE
# 1.12 23-Oct-2011 nicm

Try to resolve relative paths for loadb and saveb (first using client
working directory if any then default-path or session wd).


# 1.11 23-Oct-2011 nicm

Plug a memory leak and update some comments, from Tiago Cunha.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


# 1.9 30-Dec-2010 nicm

Change from a per-session stack of buffers to one global stack which is
much more convenient and also simplifies lot of code. This renders
copy-buffer useless and makes buffer-limit now a server option.

By Tiago Cunha.


Revision tags: OPENBSD_4_8_BASE
# 1.8 24-Jul-2010 nicm

When changing so that the client passes its stdout and stderr as well as
stdin up to the server, I forgot one essential point - the tmux server
could now be both the producer and consumer. This happens when tmux is
run inside tmux, as well as when piping tmux commands together.

So, using stdio(3) was a bad idea - if sufficient data was written, this
could block in write(2). When that happened and the server was both
producer and consumer, it deadlocks.

Change to use libevent bufferevents for the client stdin, stdout and
stderr instead. This is trivial enough for output but requires a
callback mechanism to trigger when stdin is finished.

This relies on the underlying polling mechanism for libevent to work
with whatever devices to which the user could redirect stdin, stdout or
stderr, hence the change to use poll(2) over kqueue(2) for tmux.


# 1.7 28-Jun-2010 nicm

Send all three of stdin, stdout, stderr from the client to the server, so that
commands can directly make use of them. This means that load-buffer and
save-buffer can have "-" as the file to read from stdin or write to stdout.

This is a protocol version bump so the tmux server will need to be restarted
after upgrade (or an older client used).


Revision tags: OPENBSD_4_7_BASE
# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 26-Oct-2009 nicm

Reset the umask right after fopen to avoid leaving it changed on error, noticed
by deraadt@.


# 1.4 07-Sep-2009 nicm

Give each paste buffer a size member instead of requiring them to be
zero-terminated.


# 1.3 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.44 11-Jul-2018 nicm

Expand formats in load-buffer and save-buffer.


Revision tags: OPENBSD_6_2_BASE OPENBSD_6_3_BASE
# 1.43 22-Apr-2017 nicm

Memory leaks, from David CARLIER.


Revision tags: OPENBSD_6_1_BASE
# 1.42 14-Feb-2017 nicm

Make source-file look for files relative to the client working directory
(like load-buffer and save-buffer), from Chris Pickel. Also break the
where-is-this-file code out into its own function for loadb and saveb.


# 1.41 06-Jan-2017 nicm

Nits found with clang.


# 1.40 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.39 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.38 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


Revision tags: OPENBSD_6_0_BASE
# 1.37 05-Mar-2016 nicm

Do not use c->cwd or s->cwd if it is NULL, found by Ben Boeckel.


Revision tags: OPENBSD_5_9_BASE
# 1.36 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.35 13-Dec-2015 nicm

Instead of every command resolving the target (-t or -s) itself, prepare
the state (client, session, winlink, pane) for it it before entering the
command. Each command provides some flags that tell the prepare step
what it is expecting.

This is a requirement for having hooks on commands (for example, if you
hook "select-window -t1:2", the hook command should to operate on window
1:2 not whatever it thinks is the current window), and should allow some
other target improvements.

The old cmd_find_* functions remain for the moment but that layer will
be dropped later.

Joint work with Thomas Adam.


# 1.34 14-Nov-2015 nicm

Push stdout and stderr to clients more aggressively, and add an event to
continue if the send fails.


# 1.33 10-Nov-2015 nicm

If realpath() fails just try the original path.


# 1.32 10-Nov-2015 nicm

Handle absolute paths properly, and don't use resolved path in
realpath() fails.


# 1.31 31-Oct-2015 nicm

Because pledge(2) does not allow us to pass directory file descriptors
around, we can't use file descriptors for the working directory because
we will be unable to pass it to a privileged process to tell it where to
read or write files or spawn children. So move tmux back to using
strings for the current working directory. We try to check it exists
with access() when it is set but ultimately fall back to ~ if it fails
at time of use (or / if that fails too).


# 1.30 29-Aug-2015 nicm

paste_send_pane can be merged into cmd-paste-buffer.c now.


# 1.29 29-Aug-2015 nicm

Move struct paste_buffer out of tmux.h.


Revision tags: OPENBSD_5_8_BASE
# 1.28 27-Apr-2015 nicm

Rewrite of the target resolution internals to be simpler and more
consistent but with much less duplication, but keeping the same internal
API. Also adds more readable aliases for some of the special tokens used
in targets (eg "{start}" instead of "^"). Some behaviours may have
changed, for example prefix matches now happen before fnmatch.


Revision tags: OPENBSD_5_7_BASE
# 1.27 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


# 1.26 08-Oct-2014 nicm

Add xreallocarray and remove nmemb argument from xrealloc.


Revision tags: OPENBSD_5_6_BASE
# 1.25 13-May-2014 nicm

Add support for named buffers. If you don't name a buffer, things work
much as before - buffers are automatically named "buffer0000",
"buffer0001" and so on and ordered as a stack. Buffers can be named
explicitly when creating ("loadb -b foo" etc) or renamed ("setb -b
buffer0000 -n foo"). If buffers are named explicitly, they are not
deleted when buffer-limit is reached. Diff from J Raynor.


# 1.24 24-Apr-2014 nicm

There is no longer a need for a paste_stack struct or for global_buffers
to be global. Move to paste.c.


# 1.23 16-Apr-2014 nicm

Memory leak in error path and unnecessary assignment, from clang.


# 1.22 07-Apr-2014 nicm

save-buffer needs to use O_TRUNC.


Revision tags: OPENBSD_5_5_BASE
# 1.21 10-Oct-2013 nicm

Alter how tmux handles the working directory to internally use file
descriptors rather than strings.

- Each session still has a current working directory.

- New sessions still get their working directory from the client that
created them or its attached session if any.

- New windows are created by default in the session working directory.

- The -c flag to new, neww, splitw allows the working directory to be
overridden.

- The -c flag to attach let's the session working directory be changed.

- The default-path option has been removed.

To get the equivalent to default-path '.', do:

bind c neww -c $PWD

To get the equivalent of default-path '~', do:

bind c neww -c ~

This also changes the client identify protocol to be a set of messages rather
than one as well as some other changes that should make it easier to make
backwards-compatible protocol changes in future.


# 1.20 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.19 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.18 24-Mar-2013 nicm

Merge show-buffer into save-buffer.


# 1.17 22-Mar-2013 nicm

Fix so capture-pane/save-buffer can work in control clients, from George
Nachman.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.16 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.15 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


# 1.14 21-May-2012 nicm

Instead of passing stdin/stdout/stderr file descriptors over imsg and
handling them in the server, handle them in the client and pass buffers
over imsg. This is much tidier for some upcoming changes and the
performance hit isn't critical.

The tty fd is still passed to the server as before.

This bumps the tmux protocol version so new clients and old servers are
incompatible.


# 1.13 21-Mar-2012 nicm

Fix save-buffer usage, from Kazuhiko Sakaguchi.


Revision tags: OPENBSD_5_1_BASE
# 1.12 23-Oct-2011 nicm

Try to resolve relative paths for loadb and saveb (first using client
working directory if any then default-path or session wd).


# 1.11 23-Oct-2011 nicm

Plug a memory leak and update some comments, from Tiago Cunha.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


# 1.9 30-Dec-2010 nicm

Change from a per-session stack of buffers to one global stack which is
much more convenient and also simplifies lot of code. This renders
copy-buffer useless and makes buffer-limit now a server option.

By Tiago Cunha.


Revision tags: OPENBSD_4_8_BASE
# 1.8 24-Jul-2010 nicm

When changing so that the client passes its stdout and stderr as well as
stdin up to the server, I forgot one essential point - the tmux server
could now be both the producer and consumer. This happens when tmux is
run inside tmux, as well as when piping tmux commands together.

So, using stdio(3) was a bad idea - if sufficient data was written, this
could block in write(2). When that happened and the server was both
producer and consumer, it deadlocks.

Change to use libevent bufferevents for the client stdin, stdout and
stderr instead. This is trivial enough for output but requires a
callback mechanism to trigger when stdin is finished.

This relies on the underlying polling mechanism for libevent to work
with whatever devices to which the user could redirect stdin, stdout or
stderr, hence the change to use poll(2) over kqueue(2) for tmux.


# 1.7 28-Jun-2010 nicm

Send all three of stdin, stdout, stderr from the client to the server, so that
commands can directly make use of them. This means that load-buffer and
save-buffer can have "-" as the file to read from stdin or write to stdout.

This is a protocol version bump so the tmux server will need to be restarted
after upgrade (or an older client used).


Revision tags: OPENBSD_4_7_BASE
# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 26-Oct-2009 nicm

Reset the umask right after fopen to avoid leaving it changed on error, noticed
by deraadt@.


# 1.4 07-Sep-2009 nicm

Give each paste buffer a size member instead of requiring them to be
zero-terminated.


# 1.3 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


Revision tags: OPENBSD_6_2_BASE
# 1.43 22-Apr-2017 nicm

Memory leaks, from David CARLIER.


Revision tags: OPENBSD_6_1_BASE
# 1.42 14-Feb-2017 nicm

Make source-file look for files relative to the client working directory
(like load-buffer and save-buffer), from Chris Pickel. Also break the
where-is-this-file code out into its own function for loadb and saveb.


# 1.41 06-Jan-2017 nicm

Nits found with clang.


# 1.40 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.39 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.38 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


Revision tags: OPENBSD_6_0_BASE
# 1.37 05-Mar-2016 nicm

Do not use c->cwd or s->cwd if it is NULL, found by Ben Boeckel.


Revision tags: OPENBSD_5_9_BASE
# 1.36 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.35 13-Dec-2015 nicm

Instead of every command resolving the target (-t or -s) itself, prepare
the state (client, session, winlink, pane) for it it before entering the
command. Each command provides some flags that tell the prepare step
what it is expecting.

This is a requirement for having hooks on commands (for example, if you
hook "select-window -t1:2", the hook command should to operate on window
1:2 not whatever it thinks is the current window), and should allow some
other target improvements.

The old cmd_find_* functions remain for the moment but that layer will
be dropped later.

Joint work with Thomas Adam.


# 1.34 14-Nov-2015 nicm

Push stdout and stderr to clients more aggressively, and add an event to
continue if the send fails.


# 1.33 10-Nov-2015 nicm

If realpath() fails just try the original path.


# 1.32 10-Nov-2015 nicm

Handle absolute paths properly, and don't use resolved path in
realpath() fails.


# 1.31 31-Oct-2015 nicm

Because pledge(2) does not allow us to pass directory file descriptors
around, we can't use file descriptors for the working directory because
we will be unable to pass it to a privileged process to tell it where to
read or write files or spawn children. So move tmux back to using
strings for the current working directory. We try to check it exists
with access() when it is set but ultimately fall back to ~ if it fails
at time of use (or / if that fails too).


# 1.30 29-Aug-2015 nicm

paste_send_pane can be merged into cmd-paste-buffer.c now.


# 1.29 29-Aug-2015 nicm

Move struct paste_buffer out of tmux.h.


Revision tags: OPENBSD_5_8_BASE
# 1.28 27-Apr-2015 nicm

Rewrite of the target resolution internals to be simpler and more
consistent but with much less duplication, but keeping the same internal
API. Also adds more readable aliases for some of the special tokens used
in targets (eg "{start}" instead of "^"). Some behaviours may have
changed, for example prefix matches now happen before fnmatch.


Revision tags: OPENBSD_5_7_BASE
# 1.27 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


# 1.26 08-Oct-2014 nicm

Add xreallocarray and remove nmemb argument from xrealloc.


Revision tags: OPENBSD_5_6_BASE
# 1.25 13-May-2014 nicm

Add support for named buffers. If you don't name a buffer, things work
much as before - buffers are automatically named "buffer0000",
"buffer0001" and so on and ordered as a stack. Buffers can be named
explicitly when creating ("loadb -b foo" etc) or renamed ("setb -b
buffer0000 -n foo"). If buffers are named explicitly, they are not
deleted when buffer-limit is reached. Diff from J Raynor.


# 1.24 24-Apr-2014 nicm

There is no longer a need for a paste_stack struct or for global_buffers
to be global. Move to paste.c.


# 1.23 16-Apr-2014 nicm

Memory leak in error path and unnecessary assignment, from clang.


# 1.22 07-Apr-2014 nicm

save-buffer needs to use O_TRUNC.


Revision tags: OPENBSD_5_5_BASE
# 1.21 10-Oct-2013 nicm

Alter how tmux handles the working directory to internally use file
descriptors rather than strings.

- Each session still has a current working directory.

- New sessions still get their working directory from the client that
created them or its attached session if any.

- New windows are created by default in the session working directory.

- The -c flag to new, neww, splitw allows the working directory to be
overridden.

- The -c flag to attach let's the session working directory be changed.

- The default-path option has been removed.

To get the equivalent to default-path '.', do:

bind c neww -c $PWD

To get the equivalent of default-path '~', do:

bind c neww -c ~

This also changes the client identify protocol to be a set of messages rather
than one as well as some other changes that should make it easier to make
backwards-compatible protocol changes in future.


# 1.20 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.19 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.18 24-Mar-2013 nicm

Merge show-buffer into save-buffer.


# 1.17 22-Mar-2013 nicm

Fix so capture-pane/save-buffer can work in control clients, from George
Nachman.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.16 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.15 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


# 1.14 21-May-2012 nicm

Instead of passing stdin/stdout/stderr file descriptors over imsg and
handling them in the server, handle them in the client and pass buffers
over imsg. This is much tidier for some upcoming changes and the
performance hit isn't critical.

The tty fd is still passed to the server as before.

This bumps the tmux protocol version so new clients and old servers are
incompatible.


# 1.13 21-Mar-2012 nicm

Fix save-buffer usage, from Kazuhiko Sakaguchi.


Revision tags: OPENBSD_5_1_BASE
# 1.12 23-Oct-2011 nicm

Try to resolve relative paths for loadb and saveb (first using client
working directory if any then default-path or session wd).


# 1.11 23-Oct-2011 nicm

Plug a memory leak and update some comments, from Tiago Cunha.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


# 1.9 30-Dec-2010 nicm

Change from a per-session stack of buffers to one global stack which is
much more convenient and also simplifies lot of code. This renders
copy-buffer useless and makes buffer-limit now a server option.

By Tiago Cunha.


Revision tags: OPENBSD_4_8_BASE
# 1.8 24-Jul-2010 nicm

When changing so that the client passes its stdout and stderr as well as
stdin up to the server, I forgot one essential point - the tmux server
could now be both the producer and consumer. This happens when tmux is
run inside tmux, as well as when piping tmux commands together.

So, using stdio(3) was a bad idea - if sufficient data was written, this
could block in write(2). When that happened and the server was both
producer and consumer, it deadlocks.

Change to use libevent bufferevents for the client stdin, stdout and
stderr instead. This is trivial enough for output but requires a
callback mechanism to trigger when stdin is finished.

This relies on the underlying polling mechanism for libevent to work
with whatever devices to which the user could redirect stdin, stdout or
stderr, hence the change to use poll(2) over kqueue(2) for tmux.


# 1.7 28-Jun-2010 nicm

Send all three of stdin, stdout, stderr from the client to the server, so that
commands can directly make use of them. This means that load-buffer and
save-buffer can have "-" as the file to read from stdin or write to stdout.

This is a protocol version bump so the tmux server will need to be restarted
after upgrade (or an older client used).


Revision tags: OPENBSD_4_7_BASE
# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 26-Oct-2009 nicm

Reset the umask right after fopen to avoid leaving it changed on error, noticed
by deraadt@.


# 1.4 07-Sep-2009 nicm

Give each paste buffer a size member instead of requiring them to be
zero-terminated.


# 1.3 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti