bump version to 0.8
[tabbed.git] / tabbed.1
blob07bdbd79d5f46aa68e22c8fedfe724a95e301def
1 .TH TABBED 1 tabbed\-VERSION
2 .SH NAME
3 tabbed \- generic tabbed interface
4 .SH SYNOPSIS
5 .B tabbed
6 .RB [ \-c ]
7 .RB [ \-d ]
8 .RB [ \-k ]
9 .RB [ \-s ]
10 .RB [ \-v ]
11 .RB [ \-g
12 .IR geometry ]
13 .RB [ \-n
14 .IR name ]
15 .RB [ \-p
16 .RB [ s {+/-} ] \fIpos\fR ]
17 .RB [ \-o
18 .IR normbgcol ]
19 .RB [ \-O
20 .IR normfgcol ]
21 .RB [ \-t
22 .IR selbgcol ]
23 .RB [ \-T
24 .IR selfgcol ]
25 .RB [ \-u
26 .IR urgbgcol ]
27 .RB [ \-U
28 .IR urgfgcol ]
29 .RB [ \-r
30 .IR narg ]
31 .RI [ "command ..." ]
32 .SH DESCRIPTION
33 .B tabbed
34 is a simple tabbed container for applications which support XEmbed. Tabbed
35 will then run the provided command with the xid of tabbed as appended
36 argument. (See EXAMPLES.) The automatic spawning of the command can be
37 disabled by providing the -s parameter. If no command is provided
38 tabbed will just print its xid and run no command.
39 .SH OPTIONS
40 .TP
41 .B \-c
42 close tabbed when the last tab is closed. Mutually exclusive with -f.
43 .TP
44 .B \-d
45 detaches tabbed from the terminal and prints its XID to stdout.
46 .TP
47 .B \-f
48 fill up tabbed again by spawning the provided command, when the last tab is
49 closed. Mutually exclusive with -c.
50 .TP
51 .BI \-g " geometry"
52 defines the X11 geometry string, which will fixate the height and width of
53 tabbed.
54 The syntax is
55 .RI [=][ width {xX} height ][{+-} xoffset {+-} yoffset ].
56 See
57 .BR XParseGeometry (3)
58 for further details.
59 .TP
60 .B \-k
61 close foreground tabbed client (instead of tabbed and all clients) when
62 WM_DELETE_WINDOW is sent.
63 .TP
64 .BI \-n " name"
65 will set the WM_CLASS attribute to
66 .I name.
67 .TP
68 .BR \-p " [" s {+-}] \fIpos\fR
69 will set the absolute or relative position of where to start a new tab. When
70 .I pos
71 is is given without 's' in front it is an absolute position. Then negative
72 numbers will be the position from the last tab, where -1 is the last tab.
73 If 's' is given, then
74 .I pos
75 is a relative position to the current selected tab. If this reaches the limits
76 of the tabs; those limits then apply.
77 .TP
78 .BI \-r " narg"
79 will replace the
80 .I narg
81 th argument in
82 .I command
83 with the window id, rather than appending it to the end.
84 .TP
85 .B \-s
86 will disable automatic spawning of the command.
87 .TP
88 .BI \-o " normbgcol"
89 defines the normal background color.
90 .RI # RGB ,
91 .RI # RRGGBB ,
92 and X color names are supported.
93 .TP
94 .BI \-O " normfgcol"
95 defines the normal foreground color.
96 .TP
97 .BI \-t " selbgcol"
98 defines the selected background color.
99 .TP
100 .BI \-T " selfgbcol"
101 defines the selected foreground color.
103 .BI \-u " urgbgcol"
104 defines the urgent background color.
106 .BI \-U " urgfgbcol"
107 defines the urgent foreground color.
109 .B \-v
110 prints version information to stderr, then exits.
111 .SH USAGE
113 .B Ctrl\-Shift\-Return
114 open new tab
116 .B Ctrl\-Shift\-h
117 previous tab
119 .B Ctrl\-Shift\-l
120 next tab
122 .B Ctrl\-Shift\-j
123 move selected tab one to the left
125 .B Ctrl\-Shift\-k
126 move selected tab one to the right
128 .B Ctrl\-Shift\-u
129 toggle autofocus of urgent tabs
131 .B Ctrl\-Tab
132 toggle between the selected and last selected tab
134 .B Ctrl\-`
135 open dmenu to either create a new tab appending the entered string or select
136 an already existing tab.
138 .B Ctrl\-q
139 close tab
141 .B Ctrl\-u
142 focus next urgent tab
144 .B Ctrl\-[0..9]
145 jumps to nth tab
147 .B F11
148 Toggle fullscreen mode.
149 .SH EXAMPLES
150 $ tabbed surf -e
152 $ tabbed urxvt -embed
154 $ tabbed xterm -into
156 $ $(tabbed -d >/tmp/tabbed.xid); urxvt -embed $(</tmp/tabbed.xid);
158 $ tabbed -r 2 st -w '' -e tmux
159 .SH CUSTOMIZATION
160 .B tabbed
161 can be customized by creating a custom config.h and (re)compiling the source
162 code. This keeps it fast, secure and simple.
163 .SH AUTHORS
164 See the LICENSE file for the authors.
165 .SH LICENSE
166 See the LICENSE file for the terms of redistribution.
167 .SH SEE ALSO
168 .BR st (1),
169 .BR xembed (1)
170 .SH BUGS
171 Please report them.