aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuri Linkov2020-04-21 02:23:35 +0300
committerJuri Linkov2020-04-21 02:23:35 +0300
commit692ad40539805e435a16b90067fa5917e4fea9f8 (patch)
tree13ca872e6fd6c763ad6b8a6bd10d91c7e8410575
parent05089a4d65831c5e873956f5f2d92a3d5672d405 (diff)
downloademacs-692ad40539805e435a16b90067fa5917e4fea9f8.tar.gz
emacs-692ad40539805e435a16b90067fa5917e4fea9f8.zip
Improve the documentation of tab-bar and tab-line
* doc/emacs/frames.texi (Tab Bars): Add xref to "Tab Line". Document more commands. * doc/emacs/windows.texi (Windows): * doc/emacs/emacs.texi (Top): Add "Tab Line" menu. * doc/emacs/windows.texi (Window Convenience): Move tab-line documentation to new node "Tab Line". (Tab Line): New node. * doc/emacs/glossary.texi (Glossary): * doc/emacs/modes.texi (Minor Modes): * doc/emacs/display.texi (Standard Faces): Add xref to "Tab Line".
-rw-r--r--doc/emacs/display.texi1
-rw-r--r--doc/emacs/emacs.texi1
-rw-r--r--doc/emacs/frames.texi62
-rw-r--r--doc/emacs/glossary.texi2
-rw-r--r--doc/emacs/misc.texi2
-rw-r--r--doc/emacs/modes.texi2
-rw-r--r--doc/emacs/windows.texi37
-rw-r--r--etc/NEWS12
8 files changed, 90 insertions, 29 deletions
diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi
index 4273357995f..d98441b5ab8 100644
--- a/doc/emacs/display.texi
+++ b/doc/emacs/display.texi
@@ -735,6 +735,7 @@ in a way that does not interact well with @code{highlight}.
735@cindex @code{tab-line} face 735@cindex @code{tab-line} face
736Similar to @code{mode-line} for a window's tab line, which appears 736Similar to @code{mode-line} for a window's tab line, which appears
737at the top of a window with tabs representing window buffers. 737at the top of a window with tabs representing window buffers.
738@xref{Tab Line}.
738@item vertical-border 739@item vertical-border
739@cindex @code{vertical-border} face 740@cindex @code{vertical-border} face
740This face is used for the vertical divider between windows on text 741This face is used for the vertical divider between windows on text
diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi
index 60f2be9a513..6b82aeb8234 100644
--- a/doc/emacs/emacs.texi
+++ b/doc/emacs/emacs.texi
@@ -517,6 +517,7 @@ Multiple Windows
517* Displaying Buffers:: How Emacs picks a window for displaying a buffer. 517* Displaying Buffers:: How Emacs picks a window for displaying a buffer.
518* Temporary Displays:: Displaying non-editable buffers. 518* Temporary Displays:: Displaying non-editable buffers.
519* Window Convenience:: Convenience functions for window handling. 519* Window Convenience:: Convenience functions for window handling.
520* Tab Line:: Window tab line.
520 521
521Displaying a Buffer in a Window 522Displaying a Buffer in a Window
522 523
diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index 94218424d37..d9373b8bc78 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -1262,6 +1262,12 @@ sessions (@pxref{Saving Emacs Sessions}), the tabs from the Tab Bar are
1262recorded in the desktop file, together with their associated window 1262recorded in the desktop file, together with their associated window
1263configurations, and will be available after restoring the session. 1263configurations, and will be available after restoring the session.
1264 1264
1265Note that the Tab Bar is different from the Tab Line (@pxref{Tab Line}).
1266Whereas tabs on the Tab Line at the top of each window are used to
1267switch between buffers, tabs on the Tab Bar at the top of each frame
1268are used to switch between window configurations containing several
1269windows.
1270
1265@findex tab-bar-mode 1271@findex tab-bar-mode
1266 To toggle the use of tab bars, type @kbd{M-x tab-bar-mode}. This 1272 To toggle the use of tab bars, type @kbd{M-x tab-bar-mode}. This
1267command applies to all frames, including frames yet to be created. To 1273command applies to all frames, including frames yet to be created. To
@@ -1275,9 +1281,11 @@ is turned on automatically. If the value is @code{t}, then
1275tabs. The value @code{1} hides the tab bar when it has only one tab, 1281tabs. The value @code{1} hides the tab bar when it has only one tab,
1276and shows it again when more tabs are created. The value @code{nil} 1282and shows it again when more tabs are created. The value @code{nil}
1277always keeps the tab bar hidden; in this case it's still possible to 1283always keeps the tab bar hidden; in this case it's still possible to
1278use persistent named window configurations without using the tab bar 1284switch between named window configurations without the tab bar by
1279by typing the related commands: @kbd{M-x tab-new}, @kbd{M-x tab-next}, 1285using @kbd{M-x tab-next}, @kbd{M-x tab-switcher}, and other commands
1280@kbd{M-x tab-close}, @kbd{M-x tab-switcher}, etc. 1286that provide completion on tab names. Also it's possible to create
1287and close tabs without the tab bar by using commands @kbd{M-x
1288tab-new}, @kbd{M-x tab-close}, etc.
1281 1289
1282@kindex C-x t 1290@kindex C-x t
1283 The prefix key @kbd{C-x t} is analogous to @kbd{C-x 5}. 1291 The prefix key @kbd{C-x t} is analogous to @kbd{C-x 5}.
@@ -1286,7 +1294,8 @@ Whereas each @kbd{C-x 5} command pops up a buffer in a different frame
1286tab with a different window configuration in the selected frame. 1294tab with a different window configuration in the selected frame.
1287 1295
1288 The various @kbd{C-x t} commands differ in how they find or create the 1296 The various @kbd{C-x t} commands differ in how they find or create the
1289buffer to select: 1297buffer to select. The following commands can be used to select a buffer
1298in a new tab:
1290 1299
1291@table @kbd 1300@table @kbd
1292@item C-x t 2 1301@item C-x t 2
@@ -1295,19 +1304,18 @@ buffer to select:
1295Add a new tab (@code{tab-new}). You can control the choice of the 1304Add a new tab (@code{tab-new}). You can control the choice of the
1296buffer displayed in a new tab by customizing the variable 1305buffer displayed in a new tab by customizing the variable
1297@code{tab-bar-new-tab-choice}. 1306@code{tab-bar-new-tab-choice}.
1307
1298@item C-x t b @var{bufname} @key{RET} 1308@item C-x t b @var{bufname} @key{RET}
1299Select buffer @var{bufname} in another tab. This runs 1309Select buffer @var{bufname} in another tab. This runs
1300@code{switch-to-buffer-other-tab}. 1310@code{switch-to-buffer-other-tab}.
1311
1301@item C-x t f @var{filename} @key{RET} 1312@item C-x t f @var{filename} @key{RET}
1302Visit file @var{filename} and select its buffer in another tab. This 1313Visit file @var{filename} and select its buffer in another tab. This
1303runs @code{find-file-other-tab}. @xref{Visiting}. 1314runs @code{find-file-other-tab}. @xref{Visiting}.
1315
1304@item C-x t d @var{directory} @key{RET} 1316@item C-x t d @var{directory} @key{RET}
1305Select a Dired buffer for directory @var{directory} in another tab. 1317Select a Dired buffer for directory @var{directory} in another tab.
1306This runs @code{dired-other-tab}. @xref{Dired}. 1318This runs @code{dired-other-tab}. @xref{Dired}.
1307@item C-x t r @var{tabname} @key{RET}
1308Renames the current tab to @var{tabname}. You can control the
1309programmatic name given to a tab by default by customizing the
1310variable @code{tab-bar-tab-name-function}.
1311@end table 1319@end table
1312 1320
1313@vindex tab-bar-new-tab-choice 1321@vindex tab-bar-new-tab-choice
@@ -1316,7 +1324,7 @@ current before calling the command that adds a new tab.
1316To start a new tab with other buffers, customize the variable 1324To start a new tab with other buffers, customize the variable
1317@code{tab-bar-new-tab-choice}. 1325@code{tab-bar-new-tab-choice}.
1318 1326
1319 The following commands are used to delete and operate on tabs: 1327 The following commands can be used to delete tabs:
1320 1328
1321@table @kbd 1329@table @kbd
1322@item C-x t 0 1330@item C-x t 0
@@ -1325,19 +1333,45 @@ To start a new tab with other buffers, customize the variable
1325Close the selected tab (@code{tab-close}). It has no effect if there 1333Close the selected tab (@code{tab-close}). It has no effect if there
1326is only one tab. 1334is only one tab.
1327 1335
1336@item C-x t 1
1337@kindex C-x t 1
1338@findex tab-close-other
1339Close all tabs on the selected frame, except the selected one.
1340@end table
1341
1342 The following commands can be used to switch between tabs:
1343
1344@table @kbd
1328@item C-x t o 1345@item C-x t o
1346@itemx C-@key{TAB}
1329@kindex C-x t o 1347@kindex C-x t o
1330@kindex C-TAB 1348@kindex C-TAB
1331@findex tab-next 1349@findex tab-next
1332Switch to another tab. If you repeat this command, it cycles through 1350Switch to the next tab. If you repeat this command, it cycles through
1333all the tabs on the selected frame. With a positive numeric argument 1351all the tabs on the selected frame. With a positive numeric argument
1334N, it switches to the next Nth tab; with a negative argument −N, it 1352N, it switches to the next Nth tab; with a negative argument −N, it
1335switches back to the previous Nth tab. 1353switches back to the previous Nth tab.
1336 1354
1337@item C-x t 1 1355@item S-C-@key{TAB}
1338@kindex C-x t 1 1356@kindex S-C-TAB
1339@findex tab-close-other 1357@findex tab-previous
1340Close all tabs on the selected frame, except the selected one. 1358Switch to the previous tab. With a positive numeric argument N, it
1359switches to the previous Nth tab; with a negative argument −N, it
1360switches back to the next Nth tab.
1361@end table
1362
1363 The following commands can be used to operate on tabs:
1364
1365@table @kbd
1366@item C-x t r @var{tabname} @key{RET}
1367Rename the current tab to @var{tabname}. You can control the
1368programmatic name given to a tab by default by customizing the
1369variable @code{tab-bar-tab-name-function}.
1370
1371@item C-x t m
1372Move the current tab N positions to the right with a positive numeric
1373argument N. With a negative argument −N, it moves the current tab
1374N positions to the left.
1341@end table 1375@end table
1342 1376
1343@node Dialog Boxes 1377@node Dialog Boxes
diff --git a/doc/emacs/glossary.texi b/doc/emacs/glossary.texi
index 416431b8cd4..4d622ec0e3f 100644
--- a/doc/emacs/glossary.texi
+++ b/doc/emacs/glossary.texi
@@ -1367,7 +1367,7 @@ configurations. @xref{Tab Bars}.
1367 1367
1368@item Tab Line 1368@item Tab Line
1369The tab line is a line of tabs at the top of an Emacs window. 1369The tab line is a line of tabs at the top of an Emacs window.
1370Clicking on one of these tabs switches window buffers. 1370Clicking on one of these tabs switches window buffers. @xref{Tab Line}.
1371 1371
1372@anchor{Glossary---Tags Table} 1372@anchor{Glossary---Tags Table}
1373@item Tags Table 1373@item Tags Table
diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi
index a15aa17a66f..dceb8d3ca5b 100644
--- a/doc/emacs/misc.texi
+++ b/doc/emacs/misc.texi
@@ -791,7 +791,7 @@ the same number of columns as provided by the shell.
791@vindex shell-command-prompt-show-cwd 791@vindex shell-command-prompt-show-cwd
792 To make the above commands show the current directory in their 792 To make the above commands show the current directory in their
793prompts, customize the variable @code{shell-command-prompt-show-cwd} 793prompts, customize the variable @code{shell-command-prompt-show-cwd}
794to a non-nil value. 794to a non-@code{nil} value.
795 795
796@kindex M-| 796@kindex M-|
797@findex shell-command-on-region 797@findex shell-command-on-region
diff --git a/doc/emacs/modes.texi b/doc/emacs/modes.texi
index 92d60d2d7c2..f5fb6b1e797 100644
--- a/doc/emacs/modes.texi
+++ b/doc/emacs/modes.texi
@@ -299,7 +299,7 @@ Bars}.
299Tab Bar mode gives each frame a tab bar. @xref{Tab Bars}. 299Tab Bar mode gives each frame a tab bar. @xref{Tab Bars}.
300 300
301@item 301@item
302Tab Line mode gives each window a tab line. 302Tab Line mode gives each window a tab line. @xref{Tab Line}.
303 303
304@item 304@item
305Transient Mark mode highlights the region, and makes many Emacs 305Transient Mark mode highlights the region, and makes many Emacs
diff --git a/doc/emacs/windows.texi b/doc/emacs/windows.texi
index 910ef8fd88d..cb5e9bce4d1 100644
--- a/doc/emacs/windows.texi
+++ b/doc/emacs/windows.texi
@@ -21,6 +21,7 @@ one frame.
21* Change Window:: Deleting windows and changing their sizes. 21* Change Window:: Deleting windows and changing their sizes.
22* Displaying Buffers:: How Emacs picks a window for displaying a buffer. 22* Displaying Buffers:: How Emacs picks a window for displaying a buffer.
23* Window Convenience:: Convenience functions for window handling. 23* Window Convenience:: Convenience functions for window handling.
24* Tab Line:: Window tab line.
24@end menu 25@end menu
25 26
26@node Basic Window 27@node Basic Window
@@ -542,16 +543,6 @@ Reference Manual}), and cannot exceed the size of the containing frame.
542@node Window Convenience 543@node Window Convenience
543@section Convenience Features for Window Handling 544@section Convenience Features for Window Handling
544 545
545@findex global-tab-line-mode
546@cindex tab line
547 The command @code{global-tab-line-mode} toggles the display of a
548@dfn{tab line} on the top screen line of each window. The tab line
549shows special buttons (``tabs'') for each buffer that was displayed in
550a window, and allows switching to any of these buffers by clicking the
551corresponding button. You can add a tab by clicking on the @kbd{+}
552icon and delete a tab by clicking on the @kbd{x} icon of a tab. The
553mouse wheel on the tab line scrolls the tabs horizontally.
554
555@findex winner-mode 546@findex winner-mode
556@vindex winner-dont-bind-my-keys 547@vindex winner-dont-bind-my-keys
557@vindex winner-ring-size 548@vindex winner-ring-size
@@ -616,3 +607,29 @@ shown in different windows. @xref{Comparing Files}.
616 Scroll All mode (@kbd{M-x scroll-all-mode}) is a global minor mode 607 Scroll All mode (@kbd{M-x scroll-all-mode}) is a global minor mode
617that causes scrolling commands and point motion commands to apply to 608that causes scrolling commands and point motion commands to apply to
618every single window. 609every single window.
610
611
612@node Tab Line
613@section Window Tab Line
614
615@findex global-tab-line-mode
616@cindex tab line
617 The command @code{global-tab-line-mode} toggles the display of
618a @dfn{tab line} on the top screen line of each window. The Tab Line
619shows special buttons (``tabs'') for each buffer that was displayed in
620a window, and allows switching to any of these buffers by clicking the
621corresponding button. Clicking on the @kbd{+} icon adds a new buffer
622to the window-local tab line of buffers, and clicking on the @kbd{x}
623icon of a tab deletes it. The mouse wheel on the tab line scrolls
624the tabs horizontally.
625
626Selecting the previous window-local tab is the same as typing @kbd{C-x
627@key{LEFT}} (@code{previous-buffer}), selecting the next tab is the
628same as @kbd{C-x @key{RIGHT}} (@code{next-buffer}). Both commands
629support a numeric prefix argument as a repeat count.
630
631Note that the Tab Line is different from the Tab Bar (@pxref{Tab Bars}).
632Whereas tabs on the Tab Bar at the top of each frame are used to
633switch between window configurations containing several windows,
634tabs on the Tab Line at the top of each window are used to switch
635between buffers.
diff --git a/etc/NEWS b/etc/NEWS
index 091c831e9d6..fe8a8d8775b 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -2720,8 +2720,8 @@ left to higher-level functions.
2720+++ 2720+++
2721*** Tab Bar mode 2721*** Tab Bar mode
2722The new command 'tab-bar-mode' enables the tab bar at the top of each 2722The new command 'tab-bar-mode' enables the tab bar at the top of each
2723frame, where you can use tabs to switch between named persistent 2723frame (including TTY frames), where you can use tabs to switch between
2724window configurations. 2724named persistent window configurations.
2725 2725
2726The 'C-x t' sequence is the new prefix key for tab-related commands: 2726The 'C-x t' sequence is the new prefix key for tab-related commands:
2727'C-x t 2' creates a new tab; 'C-x t 0' deletes the current tab; 2727'C-x t 2' creates a new tab; 'C-x t 0' deletes the current tab;
@@ -2738,6 +2738,11 @@ when its value is "on", "yes" or "1".
2738 2738
2739The user option 'tab-bar-position' specifies where to show the tab bar. 2739The user option 'tab-bar-position' specifies where to show the tab bar.
2740 2740
2741Tab-related commands can be used even without the tab bar when
2742'tab-bar-mode' is disabled by a nil value of the user option
2743'tab-bar-show'. Without the tab bar you can switch between tabs
2744using completion on tab names, or using 'tab-switcher'.
2745
2741Read the new Info node "(emacs) Tab Bars" for full description 2746Read the new Info node "(emacs) Tab Bars" for full description
2742of all related features. 2747of all related features.
2743 2748
@@ -2752,6 +2757,9 @@ a repeat count. Clicking on the plus icon adds a new buffer to the
2752window-local tab line of buffers. Using the mouse wheel on the tab 2757window-local tab line of buffers. Using the mouse wheel on the tab
2753line scrolls tabs. 2758line scrolls tabs.
2754 2759
2760Read the new Info node "(emacs) Tab Line" for full description
2761of all related features.
2762
2755+++ 2763+++
2756** fileloop.el lets one setup multifile operations like search&replace. 2764** fileloop.el lets one setup multifile operations like search&replace.
2757 2765