circlecloud
/
tmux
mirror of https://github.com/tmux/tmux.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Quick man page update, also fix some usages and get rid of some CMD_KEY checks.

pull/1/head
Nicholas Marriott 2008-06-02 21:36:51 +00:00
parent 259dcbbc93
commit 95cc21c251
11 changed files with 73 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
TODO
View File

@ -13,7 +13,6 @@
- decide about customised status line
- could use bsearch all over the place or get rid of smaller tables (clientmsg)
- better errors when creating new windows/sessions (how?)
- commands should have to care less about CMD_KEY
- session with CMD_NOSESSION should be an error
- each command should have a print op as well for list keys
- Implicitly add exec to the commands for new windows (switch to disable it)
@ -70,6 +69,8 @@
- poll(2) is broken on OS X/Darwin, a workaround for this would be nice
- different screen model? layers perhaps? hmm
- cfg file improvements: * comments to EOL
- index on *-mode and other stuff that targets a window but is currently
sessiononly
---
[18:20] *priteau* i found something in tmux that could be tweaked to be better

4
cfg.c
View File

@ -1,4 +1,4 @@
/* $Id: cfg.c,v 1.4 2008-06-02 21:08:36 nicm Exp $ */
/* $Id: cfg.c,v 1.5 2008-06-02 21:36:51 nicm Exp $ */
/*
* Copyright (c) 2008 Nicholas Marriott <nicm@users.sourceforge.net>
@ -153,7 +153,7 @@ load_cfg(const char *path, char **causep)
return (0);
error:
while (--argc > 0)
while (--argc >= 0)
xfree(argv[argc]);
xfree(argv);

5
cmd-copy-mode.c
View File

@ -1,4 +1,4 @@
/* $Id: cmd-copy-mode.c,v 1.5 2008-06-02 18:08:16 nicm Exp $ */
/* $Id: cmd-copy-mode.c,v 1.6 2008-06-02 21:36:51 nicm Exp $ */
/*
* Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
@ -48,8 +48,7 @@ cmd_copy_mode_exec(unused void *ptr, struct cmd_ctx *ctx)
if ((s = cmd_sessiononly_get(ptr, ctx)) == NULL)
return;
if (ctx->flags & CMD_KEY)
window_set_mode(s->curw->window, &window_copy_mode);
window_set_mode(s->curw->window, &window_copy_mode);
if (ctx->cmdclient != NULL)
server_write_client(ctx->cmdclient, MSG_EXIT, NULL, 0);

4
cmd-link-window.c
View File

@ -1,4 +1,4 @@
/* $Id: cmd-link-window.c,v 1.12 2008-06-02 21:08:36 nicm Exp $ */
/* $Id: cmd-link-window.c,v 1.13 2008-06-02 21:36:51 nicm Exp $ */
/*
* Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
@ -44,7 +44,7 @@ struct cmd_link_window_data {
const struct cmd_entry cmd_link_window_entry = {
"link-window", "linkw",
"[-dk] [-s session-name] [-i index] session-name index",
"[-dk] [-i index] [-s session-name] session-name index",
0,
cmd_link_window_parse,
cmd_link_window_exec,

4
cmd-new-session.c
View File

@ -1,4 +1,4 @@
/* $Id: cmd-new-session.c,v 1.21 2008-06-02 21:08:36 nicm Exp $ */
/* $Id: cmd-new-session.c,v 1.22 2008-06-02 21:36:51 nicm Exp $ */
/*
* Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
@ -41,7 +41,7 @@ struct cmd_new_session_data {
const struct cmd_entry cmd_new_session_entry = {
"new-session", "new",
"[-d] [-s session-name] [-n window-name] [command]",
"[-d] [-n window-name] [-s session-name] [command]",
CMD_STARTSERVER|CMD_CANTNEST,
cmd_new_session_parse,
cmd_new_session_exec,

4
cmd-new-window.c
View File

@ -1,4 +1,4 @@
/* $Id: cmd-new-window.c,v 1.16 2008-06-02 21:08:36 nicm Exp $ */
/* $Id: cmd-new-window.c,v 1.17 2008-06-02 21:36:51 nicm Exp $ */
/*
* Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
@ -43,7 +43,7 @@ struct cmd_new_window_data {
const struct cmd_entry cmd_new_window_entry = {
"new-window", "neww",
"[-d] [-s session-name] [-i index] [-n name] [command]",
"[-d] [-i index] [-n name] [-s session-name] [command]",
0,
cmd_new_window_parse,
cmd_new_window_exec,

6
cmd-paste-buffer.c
View File

@ -1,4 +1,4 @@
/* $Id: cmd-paste-buffer.c,v 1.3 2008-06-02 18:08:16 nicm Exp $ */
/* $Id: cmd-paste-buffer.c,v 1.4 2008-06-02 21:36:51 nicm Exp $ */
/*
* Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
@ -51,10 +51,8 @@ cmd_paste_buffer_exec(unused void *ptr, struct cmd_ctx *ctx)
return;
w = s->curw->window;
if (ctx->flags & CMD_KEY &&
paste_buffer != NULL && *paste_buffer != '\0') {
if (paste_buffer != NULL && *paste_buffer != '\0')
buffer_write(w->out, paste_buffer, strlen(paste_buffer));
}
if (ctx->cmdclient != NULL)
server_write_client(ctx->cmdclient, MSG_EXIT, NULL, 0);

5
cmd-scroll-mode.c
View File

@ -1,4 +1,4 @@
/* $Id: cmd-scroll-mode.c,v 1.7 2008-06-02 18:08:16 nicm Exp $ */
/* $Id: cmd-scroll-mode.c,v 1.8 2008-06-02 21:36:51 nicm Exp $ */
/*
* Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
@ -48,8 +48,7 @@ cmd_scroll_mode_exec(void *ptr, struct cmd_ctx *ctx)
if ((s = cmd_sessiononly_get(ptr, ctx)) == NULL)
return;
if (ctx->flags & CMD_KEY)
window_set_mode(s->curw->window, &window_scroll_mode);
window_set_mode(s->curw->window, &window_scroll_mode);
if (ctx->cmdclient != NULL)
server_write_client(ctx->cmdclient, MSG_EXIT, NULL, 0);

4
cmd-send-keys.c
View File

@ -1,4 +1,4 @@
/* $Id: cmd-send-keys.c,v 1.3 2008-06-02 21:08:36 nicm Exp $ */
/* $Id: cmd-send-keys.c,v 1.4 2008-06-02 21:36:51 nicm Exp $ */
/*
* Copyright (c) 2008 Nicholas Marriott <nicm@users.sourceforge.net>
@ -40,7 +40,7 @@ struct cmd_send_keys_data {
};
const struct cmd_entry cmd_send_keys_entry = {
"send-keys", "send", "[-c client-name] key ...",
"send-keys", "send", "[-c client-tty] key ...",
0,
cmd_send_keys_parse,
cmd_send_keys_exec,

85
tmux.1
View File

@ -1,4 +1,4 @@
.\" $Id: tmux.1,v 1.24 2008-06-01 20:20:25 nicm Exp $
.\" $Id: tmux.1,v 1.25 2008-06-02 21:36:51 nicm Exp $
.\"
.\" Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
.\"
@ -24,9 +24,7 @@
.Nm tmux
.Bk -words
.Op Fl vV
.Op Fl c Ar client-tty
.Op Fl S Ar socket-path
.Op Fl s Ar session-name
.Ar command
.Op Ar arguments
.Ek
@ -51,12 +49,6 @@ Communication takes place through a socket, by default placed in
.Pp
The options are as follows:
.Bl -tag -width "XXXXXXXXXXXX"
.It Fl c Ar client-tty
Apply command to the client on the given tty.
Clients may be listed with the
.Ic list-clients
command (see below).
This option does not apply to all commands.
.It Fl S Ar socket-path
Specify an alternative path to the server socket.
The default is
@ -65,17 +57,6 @@ where
.Em UID
is the uid of the user who invoked
.Nm .
.It Fl s Ar session-name
Apply command to the session named
.Ar session-name .
This option does not apply to all commands.
If it is omitted and
.Nm
is invoked from a running
.Nm
client, the session the containing client is connected to will be used;
otherwise, if only one session exists, it is chosen, or if multiple sessions
exist, an error is generated.
.It Fl v
Request verbose logging.
This option may be specified multiple times for increasing verbosity.
@ -241,11 +222,32 @@ command, bound to
by default.
.El
.Sh COMMANDS
This section contains a list of the commands supported by
.Nm .
There are some flags shared by several commands; these are:
.Bl -tag -width "XXXXXXXXXXXX"
.It Fl c Ar client-tty
Apply command to the client on the given tty.
Clients may be listed with the
.Ic list-clients
command.
.It Fl s Ar session-name
Apply command to the session named
.Ar session-name .
If it is omitted and
.Nm
supports the following commands:
is invoked from a running
.Nm
client, the session the containing client is connected to will be used;
otherwise, if only one session exists, it is chosen, or if multiple sessions
exist, an error is generated.
.El
.Pp
The following commands are available:
.Bl -tag -width Ds
.It Xo Ic attach-session
.Op Fl d
.Op Fl s Ar session-name
.Xc
.D1 (alias: Ic attach )
Create a new client in the current terminal and attach it to a session.
@ -261,37 +263,43 @@ Bind key
to
.Ar command .
.It Xo Ic copy-mode
.Op Fl s Ar session-name
.Xc
Enter copy mode.
This command does nothing unless bound to a key.
.It Xo Ic detach-client
.Op Fl c Ar client-tty
.Xc
.D1 (alias: Ic detach )
Detach the current client if bound to a key, or the specified client with
.Fl c .
.It Xo Ic has-session
.Op Fl s Ar session-name
.Xc
.D1 (alias: Ic has )
Report an error and exit with 1 if the specified session does not exist. If it
does exist, exit with 0.
.It Xo Ic kill-session
.Op Fl s Ar session-name
.Xc
Destroy the given session, closing any windows linked to it and no other
sessions, and detaching all clients attached to it.
.It Xo Ic kill-window
.Op Fl i Ar index
.Op Fl s Ar session-name
.Xc
.D1 (alias: Ic killw )
Kill the current window or the window at
.Ar index ,
removing it from any sessions to which it is linked.
.It Xo Ic last-window
.Op Fl s Ar session-name
.Xc
.D1 (alias: Ic last )
Select the last (previously selected) window.
.It Xo Ic link-window
.Op Fl dk
.Op Fl i Ar destination-index
.Op Fl i Ar index
.Op Fl s Ar session-name
.Ar source-name Ar source-index
.Xc
.D1 (alias: Ic linkw )
@ -300,13 +308,13 @@ Link the window at
in session
.Ar source-name
into the specified session. If
.Ar destination-index
.Ar index
is specified and no window exists with that index, the window is linked at
that index.
If
.Fl k
is given and a window exists at
.Ar destination-index ,
.Ar index ,
it is killed, otherwise an error is generated.
If
.Fl d
@ -324,13 +332,14 @@ List all key bindings.
.D1 (alias: Ic ls )
List all sessions managed by the server.
.It Xo Ic list-windows
.Op Fl s Ar session-name
.Xc
.D1 (alias: Ic lsw )
List all windows.
.It Xo Ic new-session
.Op Fl d
.Op Fl s Ar session-name
.Op Fl n Ar window-name
.Op Fl s Ar session-name
.Op Ar command
.Xc
.D1 (alias: Ic new )
@ -347,6 +356,7 @@ are the name of and command to execute in the initial window.
.Op Fl d
.Op Fl i Ar index
.Op Fl n Ar name
.Op Fl s Ar session-name
.Op Ar command
.Xc
.D1 (alias: Ic neww )
@ -378,25 +388,30 @@ New windows will automatically have
added to their environment, but care must be taken not to reset this in shell
start-up files.
.It Xo Ic next-window
.Op Fl s Ar session-name
.Xc
.D1 (alias: Ic next )
Move to the next window in the session.
.It Xo Ic paste-buffer
.Op Fl s Ar session-name
.Xc
.D1 (alias: Ic paste )
Insert the contents of the paste buffer into the current window.
Ignored unless executed via a key binding.
.It Xo Ic previous-window
.Op Fl s Ar session-name
.Xc
.D1 (alias: Ic prev )
Move to the previous window in the session.
.It Xo Ic refresh-client
.Op Fl c Ar client-tty
.Xc
.D1 (alias: Ic refresh )
Refresh the current client if bound to a key, or a single client if one given
with
.Fl c .
.It Xo Ic rename-session
.Op Fl s Ar session-name
.Ar new-name
.Xc
.D1 (alias: Ic rename )
@ -404,6 +419,7 @@ Rename the session to
.Ar new-name .
.It Xo Ic rename-window
.Op Fl i Ar index
.Op Fl s Ar session-name
.Ar new-name
.Xc
.D1 (alias: Ic renamew )
@ -412,16 +428,19 @@ Rename the current window, or the window at
if specifed, to
.Ar new-name .
.It Xo Ic scroll-mode
.Op Fl s Ar session-name
.Xc
Enter scroll mode.
This command works only if bound to a key.
.It Xo Ic select-window
.Op Fl s Ar session-name
.Ar index
.Xc
.D1 (alias: Ic selectw )
Select the window at
.Ar index .
.It Xo Ic send-keys Ar key Ar ...
.It Xo Ic send-keys
.Op Fl c Ar client-tty
.Ar key Ar ...
.Xc
Send a key or keys to a window.
Each argument
@ -434,9 +453,9 @@ or
characters.
All the arguments are sent sequentially from first to last.
.It Xo Ic send-prefix
.Op Fl c Ar client-tty
.Xc
Send the prefix key to a window as if it was pressed.
This is ignored unless bound to a key.
.It Xo Ic set-option
.Ar option Ar value
.Xc
@ -488,7 +507,8 @@ The default is
.Dq exec $SHELL .
.El
.It Xo Ic swap-window
.Op Fl i Ar destination-index
.Op Fl i Ar index
.Op Fl s Ar session-name
.Ar source-name Ar source-index
.Xc
.D1 (alias: Ic swapw )
@ -496,15 +516,16 @@ This is similar to
.Ic link-window ,
except the source and destination windows are swapped.
It is an error if no window exists at
.Ar destination-index .
.Ar index .
.It Xo Ic unbind-key
.Ar key
.Xc
.D1 (alias: Ic unbind )
Unbind the key bound to
.Ar key .
.It Xo Ic unlink-window
.It Xo Ic unlink-window
.Op Fl i Ar index
.Op Fl s Ar session-name
.Xc
.D1 (alias: Ic unlinkw )
Unlink the window at

4
tmux.h
View File

@ -1,4 +1,4 @@
/* $Id: tmux.h,v 1.118 2008-06-02 21:08:36 nicm Exp $ */
/* $Id: tmux.h,v 1.119 2008-06-02 21:36:51 nicm Exp $ */
/*
* Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
@ -766,7 +766,7 @@ extern const struct cmd_entry cmd_unlink_window_entry;
void cmd_select_window_default(void **, int);
/* cmd-generic.c */
#define CMD_CLIENTONLY_USAGE "[-c client-name]"
#define CMD_CLIENTONLY_USAGE "[-c client-tty]"
int cmd_clientonly_parse(struct cmd *, void **, int, char **, char **);
void cmd_clientonly_exec(void *, struct cmd_ctx *);
void cmd_clientonly_send(void *, struct buffer *);