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