From 8940b9fca3df76e943bbb1ca6075bf1e6de93b0c Mon Sep 17 00:00:00 2001 From: Rick Calixte <10281587+rcalixte@users.noreply.github.com> Date: Wed, 10 Jan 2024 15:28:49 -0500 Subject: [PATCH] Updating documentation in doc/* to reflect dual keybinding options Ref: #870 --- doc/terminator.1 | 7 +-- doc/terminator.adoc | 5 +- doc/terminator_config.5 | 104 ++++++++++++++++++------------------- doc/terminator_config.adoc | 102 ++++++++++++++++++------------------ 4 files changed, 110 insertions(+), 108 deletions(-) diff --git a/doc/terminator.1 b/doc/terminator.1 index b237030a..0d039709 100644 --- a/doc/terminator.1 +++ b/doc/terminator.1 @@ -1,7 +1,7 @@ '\" t .\" Title: terminator .\" Author: [see the "AUTHOR(S)" section] -.\" Generator: Asciidoctor 2.0.18 +.\" Generator: Asciidoctor 2.0.20 .\" Date: 2023-04-01 .\" Manual: Manual for Terminator .\" Source: Terminator @@ -181,7 +181,8 @@ replace hide keyboad shortcut. .SH "KEYBINDINGS" .sp The following default keybindings can be used to control Terminator. -Most of these keybindings can be changed in the Preferences. +Most of these keybindings can be changed in the Preferences. Up to +two keybindings can be set per action. .sp \fBF1\fP .RS 4 @@ -482,4 +483,4 @@ Terminator was written by Chris Jones and others. This manual page was written by Chris Jones and others. .SH "SEE ALSO" .sp -\fBterminator_config\fP(5) +\fBterminator_config\fP(5) \ No newline at end of file diff --git a/doc/terminator.adoc b/doc/terminator.adoc index 25ba6c1c..223fdbe1 100644 --- a/doc/terminator.adoc +++ b/doc/terminator.adoc @@ -37,7 +37,7 @@ Start with a maximised window. Start with a fullscreen window. *-b*, *--borderless*:: -Instruct the window manager not to render borders/decoration on the +Instruct the window manager not to render borders/decorations on the Terminator window (this works well with --maximise). *-H*, *--hidden*:: @@ -115,7 +115,8 @@ replace hide keyboad shortcut. == KEYBINDINGS The following default keybindings can be used to control Terminator. -Most of these keybindings can be changed in the Preferences. +Most of these keybindings can be changed in the Preferences. Up to +two keybindings can be set per action. *F1*:: Launches the full HTML manual. diff --git a/doc/terminator_config.5 b/doc/terminator_config.5 index 4af2ca9b..8e2b20b2 100644 --- a/doc/terminator_config.5 +++ b/doc/terminator_config.5 @@ -1,7 +1,7 @@ '\" t .\" Title: terminator_config .\" Author: [see the "AUTHOR(S)" section] -.\" Generator: Asciidoctor 2.0.16 +.\" Generator: Asciidoctor 2.0.20 .\" Date: 2023-10-10 .\" Manual: Manual for Terminator .\" Source: Terminator @@ -54,7 +54,7 @@ This is what a Terminator config file should look like: focus = system [keybindings] - full_screen = F11 + full_screen = F11, "" [profiles] [[default]] @@ -369,63 +369,63 @@ section. .RS 4 Split the current terminal horizontally. .br -Default value: \fBO\fP +Default value: \fBO, ""\fP .RE .sp \fBsplit_vert\fP .RS 4 Split the current terminal vertically. .br -Default value: \fBE\fP +Default value: \fBE, ""\fP .RE .sp \fBsplit_auto\fP .RS 4 Split the current terminal automatically, along the longer side. .br -Default value: \fBA\fP +Default value: \fBA, ""\fP .RE .sp \fBnew_tab\fP .RS 4 Open a new tab. .br -Default value: \fBT\fP +Default value: \fBT, ""\fP .RE .sp \fBnew_window\fP .RS 4 Open a new window as part of the existing process. .br -Default value: \fBI\fP +Default value: \fBI, ""\fP .RE .sp \fBnew_terminator\fP .RS 4 Spawn a new Terminator process. .br -Default value: \fBI\fP +Default value: \fBI, ""\fP .RE .sp \fBlayout_launcher\fP .RS 4 Open the layout launcher. .br -Default value: \fBL\fP +Default value: \fBL, ""\fP .RE .sp \fBclose_term\fP .RS 4 Close the current terminal. .br -Default value: \fBW\fP +Default value: \fBW, ""\fP .RE .sp \fBclose_window\fP .RS 4 Close the current window. .br -Default value: \fBQ\fP +Default value: \fBQ, ""\fP .RE .SS "Navigation" .sp @@ -433,56 +433,56 @@ Default value: \fBQ\fP .RS 4 Focus the next terminal. This is an alias for \fBgo_next\fP. .br -Default value: \fBTab\fP +Default value: \fBTab, ""\fP .RE .sp \fBcycle_prev\fP .RS 4 Focus the previous terminal. This is an alias for \fBgo_prev\fP. .br -Default value: \fBTab\fP +Default value: \fBTab, ""\fP .RE .sp \fBgo_next\fP .RS 4 Focus the next terminal. .br -Default value: \fBN\fP +Default value: \fBN, ""\fP .RE .sp \fBgo_prev\fP .RS 4 Focus the previous terminal. .br -Default value: \fBP\fP +Default value: \fBP, ""\fP .RE .sp \fBgo_up\fP .RS 4 Focus the terminal above the current one. .br -Default value: \fBUp\fP +Default value: \fBUp, ""\fP .RE .sp \fBgo_down\fP .RS 4 Focus the terminal below the current one. .br -Default value: \fBDown\fP +Default value: \fBDown, ""\fP .RE .sp \fBgo_left\fP .RS 4 Focus the terminal to the left of the current one. .br -Default value: \fBLeft\fP +Default value: \fBLeft, ""\fP .RE .sp \fBgo_right\fP .RS 4 Focus the terminal to the right of the current one. .br -Default value: \fBRight\fP +Default value: \fBRight, ""\fP .RE .sp \fBpage_up\fP @@ -519,14 +519,14 @@ Scroll the terminal down one line. .RS 4 Move to the next tab. .br -Default value: \fBPage_Down\fP +Default value: \fBPage_Down, ""\fP .RE .sp \fBprev_tab\fP .RS 4 Move to the previous tab. .br -Default value: \fBPage_Up\fP +Default value: \fBPage_Up, ""\fP .RE .sp \fBswitch_to_tab_1\fP, \fBswitch_to_tab_2\fP, ... \fBswitch_to_tab_10\fP @@ -541,42 +541,42 @@ depending on the keyboard layout. .RS 4 Move the parent dragbar up. .br -Default value: \fBUp\fP +Default value: \fBUp, ""\fP .RE .sp \fBresize_down\fP .RS 4 Move the parent dragbar down. .br -Default value: \fBDown\fP +Default value: \fBDown, ""\fP .RE .sp \fBresize_left\fP .RS 4 Move the parent dragbar left. .br -Default value: \fBLeft\fP +Default value: \fBLeft, ""\fP .RE .sp \fBresize_right\fP .RS 4 Move the parent dragbar right. .br -Default value: \fBRight\fP +Default value: \fBRight, ""\fP .RE .sp \fBrotate_cw\fP .RS 4 Rotate terminals clockwise. .br -Default value: \fBR\fP +Default value: \fBR, ""\fP .RE .sp \fBrotate_ccw\fP .RS 4 Rotate terminals counter+clockwise. .br -Default value: \fBR\fP +Default value: \fBR, ""\fP .RE .sp \fBmove_tab_right\fP @@ -584,7 +584,7 @@ Default value: \fBR\fP Move the current tab to the right by swapping position with the next tab. .br -Default value: \fBPage_Down\fP +Default value: \fBPage_Down, ""\fP .RE .sp \fBmove_tab_left\fP @@ -592,7 +592,7 @@ Default value: \fBPage_Down\fP Move the current tab to the left by swapping position with the previous tab. .br -Default value: \fBPage_Up\fP +Default value: \fBPage_Up, ""\fP .RE .SS "Focus" .sp @@ -600,14 +600,14 @@ Default value: \fBPage_Up\fP .RS 4 Toggle window to fullscreen. .br -Default value: \fBF11\fP +Default value: \fBF11, ""\fP .RE .sp \fBtoggle_zoom\fP .RS 4 Toggle maximisation of the current terminal. .br -Default value: \fBX\fP +Default value: \fBX, ""\fP .RE .sp \fBscaled_zoom\fP @@ -615,14 +615,14 @@ Default value: \fBX\fP Toggle maximisation of the current terminal and scale the font when maximised. .br -Default value: \fBZ\fP +Default value: \fBZ, ""\fP .RE .sp \fBhide_window\fP .RS 4 Hide/Show all Terminator windows. .br -Default value: \fBA\fP +Default value: \fBA, ""\fP .RE .SS "Grouping & Broadcasting" .sp @@ -635,7 +635,7 @@ Create a new group. .RS 4 Group all terminals together. .br -Default value: \fBG\fP +Default value: \fBG, ""\fP .RE .sp \fBungroup_all\fP @@ -657,7 +657,7 @@ Group all terminals in the current window together. .RS 4 Ungroup all terminals in the current window. .br -Default value: \fBW\fP +Default value: \fBW, ""\fP .RE .sp \fBgroup_win_toggle\fP @@ -669,14 +669,14 @@ Toggle grouping of all terminals in the current window. .RS 4 Group all terminals in the current tab together. .br -Default value: \fBT\fP +Default value: \fBT, ""\fP .RE .sp \fBungroup_tab\fP .RS 4 Ungroup all terminals in the current tab. .br -Default value: \fBT\fP +Default value: \fBT, ""\fP .RE .sp \fBgroup_tab_toggle\fP @@ -716,21 +716,21 @@ Open the Preferences window. .RS 4 Open the Preferences window and show the Keybindings tab. .br -Default value: \fBK\fP +Default value: \fBK, ""\fP .RE .sp \fBcopy\fP .RS 4 Copy the selected text to the Clipboard. .br -Default value: \fBC\fP +Default value: \fBC, ""\fP .RE .sp \fBpaste\fP .RS 4 Paste the current contents of the Clipboard. .br -Default value: \fBV\fP +Default value: \fBV, ""\fP .RE .sp \fBpaste_selection\fP @@ -742,49 +742,49 @@ Paste the current contents of the Primary Selection. .RS 4 Toggle the scrollbar. .br -Default value: \fBS\fP +Default value: \fBS, ""\fP .RE .sp \fBsearch\fP .RS 4 Search for text in the terminal scrollback history. .br -Default value: \fBF\fP +Default value: \fBF, ""\fP .RE .sp \fBreset\fP .RS 4 Reset the terminal state. .br -Default value: \fBR\fP +Default value: \fBR, ""\fP .RE .sp \fBreset_clear\fP .RS 4 Reset the terminal state and clear the terminal window. .br -Default value: \fBG\fP +Default value: \fBG, ""\fP .RE .sp \fBzoom_in\fP .RS 4 Increase the font size by one unit. .br -Default value: \fBplus\fP +Default value: \fBplus, ""\fP .RE .sp \fBzoom_out\fP .RS 4 Decrease the font size by one unit. .br -Default value: \fBminus\fP +Default value: \fBminus, ""\fP .RE .sp \fBzoom_normal\fP .RS 4 Restore the original font size. .br -Default value: \fB0\fP +Default value: \fB0, ""\fP .RE .sp \fBzoom_in_all\fP @@ -806,35 +806,35 @@ Restore the original font size for all terminals. .RS 4 Rename the current window. .br -Default value: \fBW\fP +Default value: \fBW, ""\fP .RE .sp \fBedit_tab_title\fP .RS 4 Rename the current tab. .br -Default value: \fBA\fP +Default value: \fBA, ""\fP .RE .sp \fBedit_terminal_title\fP .RS 4 Rename the current terminal. .br -Default value: \fBX\fP +Default value: \fBX, ""\fP .RE .sp \fBinsert_number\fP .RS 4 Insert the current terminal\(cqs number, i.e. 1 to 12. .br -Default value: \fB1\fP +Default value: \fB1, ""\fP .RE .sp \fBinsert_padded\fP .RS 4 Insert the current terminal\(cqs number, but zero padded, i.e. 01 to 12. .br -Default value: \fB0\fP +Default value: \fB0, ""\fP .RE .sp \fBnext_profile\fP diff --git a/doc/terminator_config.adoc b/doc/terminator_config.adoc index d0b89fe8..6954c652 100644 --- a/doc/terminator_config.adoc +++ b/doc/terminator_config.adoc @@ -29,7 +29,7 @@ This is what a Terminator config file should look like: focus = system [keybindings] - full_screen = F11 + full_screen = F11, "" [profiles] [[default]] @@ -262,73 +262,73 @@ section. *split_horiz*:: Split the current terminal horizontally. + -Default value: *O* +Default value: *O, ""* *split_vert*:: Split the current terminal vertically. + -Default value: *E* +Default value: *E, ""* *split_auto*:: Split the current terminal automatically, along the longer side. + -Default value: *A* +Default value: *A, ""* *new_tab*:: Open a new tab. + -Default value: *T* +Default value: *T, ""* *new_window*:: Open a new window as part of the existing process. + -Default value: *I* +Default value: *I, ""* *new_terminator*:: Spawn a new Terminator process. + -Default value: *I* +Default value: *I, ""* *layout_launcher*:: Open the layout launcher. + -Default value: *L* +Default value: *L, ""* *close_term*:: Close the current terminal. + -Default value: *W* +Default value: *W, ""* *close_window*:: Close the current window. + -Default value: *Q* +Default value: *Q, ""* === Navigation *cycle_next*:: Focus the next terminal. This is an alias for *go_next*. + -Default value: *Tab* +Default value: *Tab, ""* *cycle_prev*:: Focus the previous terminal. This is an alias for *go_prev*. + -Default value: *Tab* +Default value: *Tab, ""* *go_next*:: Focus the next terminal. + -Default value: *N* +Default value: *N, ""* *go_prev*:: Focus the previous terminal. + -Default value: *P* +Default value: *P, ""* *go_up*:: Focus the terminal above the current one. + -Default value: *Up* +Default value: *Up, ""* *go_down*:: Focus the terminal below the current one. + -Default value: *Down* +Default value: *Down, ""* *go_left*:: Focus the terminal to the left of the current one. + -Default value: *Left* +Default value: *Left, ""* *go_right*:: Focus the terminal to the right of the current one. + -Default value: *Right* +Default value: *Right, ""* // --- Scroll --- @@ -354,11 +354,11 @@ Scroll the terminal down one line. *next_tab*:: Move to the next tab. + -Default value: *Page_Down* +Default value: *Page_Down, ""* *prev_tab*:: Move to the previous tab. + -Default value: *Page_Up* +Default value: *Page_Up, ""* *switch_to_tab_1*, *switch_to_tab_2*, ... *switch_to_tab_10*:: Move to the **N**th tab. @@ -369,56 +369,56 @@ depending on the keyboard layout. *resize_up*:: Move the parent dragbar up. + -Default value: *Up* +Default value: *Up, ""* *resize_down*:: Move the parent dragbar down. + -Default value: *Down* +Default value: *Down, ""* *resize_left*:: Move the parent dragbar left. + -Default value: *Left* +Default value: *Left, ""* *resize_right*:: Move the parent dragbar right. + -Default value: *Right* +Default value: *Right, ""* *rotate_cw*:: Rotate terminals clockwise. + -Default value: *R* +Default value: *R, ""* *rotate_ccw*:: Rotate terminals counter+clockwise. + -Default value: *R* +Default value: *R, ""* *move_tab_right*:: Move the current tab to the right by swapping position with the next tab. + -Default value: *Page_Down* +Default value: *Page_Down, ""* *move_tab_left*:: Move the current tab to the left by swapping position with the previous tab. + -Default value: *Page_Up* +Default value: *Page_Up, ""* === Focus *full_screen*:: Toggle window to fullscreen. + -Default value: *F11* +Default value: *F11, ""* *toggle_zoom*:: Toggle maximisation of the current terminal. + -Default value: *X* +Default value: *X, ""* *scaled_zoom*:: Toggle maximisation of the current terminal and scale the font when maximised. + -Default value: *Z* +Default value: *Z, ""* *hide_window*:: Hide/Show all Terminator windows. + -Default value: *A* +Default value: *A, ""* === Grouping & Broadcasting @@ -429,7 +429,7 @@ Create a new group. *group_all*:: Group all terminals together. + -Default value: *G* +Default value: *G, ""* *ungroup_all*:: Ungroup all terminals. @@ -444,7 +444,7 @@ Group all terminals in the current window together. *ungroup_win*:: Ungroup all terminals in the current window. + -Default value: *W* +Default value: *W, ""* *group_win_toggle*:: Toggle grouping of all terminals in the current window. @@ -453,11 +453,11 @@ Toggle grouping of all terminals in the current window. *group_tab*:: Group all terminals in the current tab together. + -Default value: *T* +Default value: *T, ""* *ungroup_tab*:: Ungroup all terminals in the current tab. + -Default value: *T* +Default value: *T, ""* *group_tab_toggle*:: Toggle grouping of all terminals in the current tab. @@ -484,46 +484,46 @@ Open the Preferences window. *preferences_keybindings*:: Open the Preferences window and show the Keybindings tab. + -Default value: *K* +Default value: *K, ""* *copy*:: Copy the selected text to the Clipboard. + -Default value: *C* +Default value: *C, ""* *paste*:: Paste the current contents of the Clipboard. + -Default value: *V* +Default value: *V, ""* *paste_selection*:: Paste the current contents of the Primary Selection. *toggle_scrollbar*:: Toggle the scrollbar. + -Default value: *S* +Default value: *S, ""* *search*:: Search for text in the terminal scrollback history. + -Default value: *F* +Default value: *F, ""* *reset*:: Reset the terminal state. + -Default value: *R* +Default value: *R, ""* *reset_clear*:: Reset the terminal state and clear the terminal window. + -Default value: *G* +Default value: *G, ""* *zoom_in*:: Increase the font size by one unit. + -Default value: *plus* +Default value: *plus, ""* *zoom_out*:: Decrease the font size by one unit. + -Default value: *minus* +Default value: *minus, ""* *zoom_normal*:: Restore the original font size. + -Default value: *0* +Default value: *0, ""* *zoom_in_all*:: Increase the font size by one unit for all terminals. @@ -536,23 +536,23 @@ Restore the original font size for all terminals. *edit_window_title*:: Rename the current window. + -Default value: *W* +Default value: *W, ""* *edit_tab_title*:: Rename the current tab. + -Default value: *A* +Default value: *A, ""* *edit_terminal_title*:: Rename the current terminal. + -Default value: *X* +Default value: *X, ""* *insert_number*:: Insert the current terminal's number, i.e. 1 to 12. + -Default value: *1* +Default value: *1, ""* *insert_padded*:: Insert the current terminal's number, but zero padded, i.e. 01 to 12. + -Default value: *0* +Default value: *0, ""* *next_profile*:: Switch to the next profile.