mirror of
https://github.com/tmate-io/tmate.git
synced 2024-11-23 08:33:17 +01:00
Initial man page.
This commit is contained in:
Nicholas Marriott
parent
0b832ea466
commit
d9b85594f8
3
CHANGES
3
CHANGES
@ -1,5 +1,6 @@
|
||||
09 November 2007
|
||||
|
||||
* (nicm) Initial man page outline.
|
||||
* (nicm) -V to show version.
|
||||
* (nicm) rename-session command.
|
||||
|
||||
@ -195,4 +196,4 @@
|
||||
(including mutt, emacs). No status bar yet and no key remapping or other
|
||||
customisation.
|
||||
|
||||
$Id: CHANGES,v 1.61 2007-11-09 11:03:34 nicm Exp $
|
||||
$Id: CHANGES,v 1.62 2007-11-09 15:23:28 nicm Exp $
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# $Id: GNUmakefile,v 1.2 2007-11-09 11:02:01 nicm Exp $
|
||||
# $Id: GNUmakefile,v 1.3 2007-11-09 15:23:28 nicm Exp $
|
||||
|
||||
.PHONY: clean
|
||||
|
||||
@ -75,6 +75,7 @@ depend: $(SRCS)
|
||||
|
||||
install:
|
||||
$(INSTALLBIN) $(PROG) $(DESTDIR)$(PREFIX)/bin/$(PROG)
|
||||
$(INSTALLMAN) $(PROG).1 $(DESTDIR)$(PREFIX)/man/man1/
|
||||
|
||||
clean:
|
||||
rm -f $(CLEANFILES)
|
||||
|
||||
3
Makefile
3
Makefile
@ -1,4 +1,4 @@
|
||||
# $Id: Makefile,v 1.37 2007-11-09 11:02:01 nicm Exp $
|
||||
# $Id: Makefile,v 1.38 2007-11-09 15:23:28 nicm Exp $
|
||||
|
||||
.SUFFIXES: .c .o .y .h
|
||||
.PHONY: clean
|
||||
@ -87,3 +87,4 @@ clean:
|
||||
|
||||
install: all
|
||||
${INSTALLBIN} ${PROG} ${DESTDIR}${PREFIX}/bin/${PROG}
|
||||
${INSTALLMAN} ${PROG}.1 ${DESTDIR}${PREFIX}/man/man1/
|
||||
|
||||
5
NOTES
5
NOTES
@ -14,9 +14,10 @@ There is one default server process per user which puts its socket in
|
||||
invocations will connect to the same server. The server holds multiple
|
||||
sessions.
|
||||
|
||||
Syntax is: tmux [-v] [-S path] [-s session] command [flags]
|
||||
Syntax is: tmux [-vV] [-S path] [-s session] command [flags]
|
||||
|
||||
-v Create logfiles, verbosity increases with more -v
|
||||
-V Show tmux version
|
||||
-S Set different server socket path
|
||||
-s Specify session name for command, if appropriate.
|
||||
|
||||
@ -132,4 +133,4 @@ freenode or efnet IRC. I sometimes ignore private msgs from people I don't
|
||||
know, so please mention tmux initially (rather than just saying "hi" ;-).
|
||||
|
||||
-- Nicholas Marriott <nicm@users.sf.net>
|
||||
$Id: NOTES,v 1.21 2007-10-19 20:43:55 nicm Exp $
|
||||
$Id: NOTES,v 1.22 2007-11-09 15:23:28 nicm Exp $
|
||||
|
||||
91
tmux.1
Normal file
91
tmux.1
Normal file
@ -0,0 +1,91 @@
|
||||
.\" $Id: tmux.1,v 1.1 2007-11-09 15:23:28 nicm Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
|
||||
.\"
|
||||
.\" Permission to use, copy, modify, and distribute this software for any
|
||||
.\" purpose with or without fee is hereby granted, provided that the above
|
||||
.\" copyright notice and this permission notice appear in all copies.
|
||||
.\"
|
||||
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
.\" WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
|
||||
.\" IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
|
||||
.\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
.\"
|
||||
.Dd November 9, 2007
|
||||
.Dt TMUX 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm tmux
|
||||
.Nd "terminal multiplexer"
|
||||
.Sh SYNOPSIS
|
||||
.Nm tmux
|
||||
.Bk -words
|
||||
.Op Fl vV
|
||||
.Op Fl S Ar socket-path
|
||||
.Op Fl s Ar session-name
|
||||
.Ar command
|
||||
.Op Ar arguments
|
||||
.Ek
|
||||
.Sh DESCRIPTION
|
||||
.Nm
|
||||
is a terminal multiplexer; it enables a number of terminals (or windows) to be
|
||||
accessed and controlled from a single terminal.
|
||||
.Pp
|
||||
.Nm
|
||||
is a server-client system. A server is created automatically when necessary
|
||||
and holds a number of
|
||||
.Em sessions ,
|
||||
each of which may have a number of
|
||||
.Em windows
|
||||
connected to it.
|
||||
A server is controlled by issuing commands with the
|
||||
.Nm
|
||||
binary which communicates using a socket in
|
||||
.Pa /tmp .
|
||||
.Pp
|
||||
The options are as follows:
|
||||
.Bl -tag -width "XXXXXXXXXXXX"
|
||||
.It Fl S Ar socket-path
|
||||
This specifies an alternative path to the server socket.
|
||||
The default is
|
||||
.Pa /tmp/tmux-UID ,
|
||||
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.
|
||||
Log messages will be saved into
|
||||
.Pa tmux-client-PID.log
|
||||
and
|
||||
.Pa tmux-server-PID.log
|
||||
files in the current directory, where
|
||||
.Em PID
|
||||
is the pid of the server or client process.
|
||||
.It Ar command Op Ar arguments
|
||||
This specifies one of a set of commands used to control
|
||||
.Nm ,
|
||||
and described in the following section.
|
||||
.Pp
|
||||
.El
|
||||
.Sh COMMANDS
|
||||
TBC
|
||||
.Sh SEE ALSO
|
||||
.Xr pty 4
|
||||
.Sh AUTHORS
|
||||
.An Nicholas Marriott Aq nicm@users.sourceforge.net
|
||||
Loading…
Reference in New Issue
Block a user