Doc: Describe the Terminal output pane

Fixes: QTCREATORBUG-29220
Change-Id: I407a7de1be7f485da99b445b967c768373c8c7f5
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>

13 files changed, 122 insertions, 12 deletions

diff --git a/doc/qtcreator/images/icons/terminal-close.png b/doc/qtcreator/images/icons/terminal-close.png
new file mode 100644
index 0000000000..861c01a6d2
--- /dev/null
+++ b/doc/qtcreator/images/icons/terminal-close.png
diff --git a/doc/qtcreator/images/icons/terminal-create.png b/doc/qtcreator/images/icons/terminal-create.png
new file mode 100644
index 0000000000..02e8fb2185
--- /dev/null
+++ b/doc/qtcreator/images/icons/terminal-create.png
diff --git a/doc/qtcreator/images/qtcreator-output-panes-taskbar.png b/doc/qtcreator/images/qtcreator-output-panes-taskbar.png
deleted file mode 100644
index e6430e4569..0000000000
--- a/doc/qtcreator/images/qtcreator-output-panes-taskbar.png
+++ /dev/null
diff --git a/doc/qtcreator/images/qtcreator-output-panes-taskbar.webp b/doc/qtcreator/images/qtcreator-output-panes-taskbar.webp
new file mode 100644
index 0000000000..27b5517cb4
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-output-panes-taskbar.webp
diff --git a/doc/qtcreator/images/qtcreator-output-terminal.webp b/doc/qtcreator/images/qtcreator-output-terminal.webp
new file mode 100644
index 0000000000..ac3f444cef
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-output-terminal.webp
diff --git a/doc/qtcreator/images/qtcreator-preferences-terminal.webp b/doc/qtcreator/images/qtcreator-preferences-terminal.webp
new file mode 100644
index 0000000000..5772f8ee94
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-preferences-terminal.webp
diff --git a/doc/qtcreator/src/howto/creator-keyboard-shortcuts.qdoc b/doc/qtcreator/src/howto/creator-keyboard-shortcuts.qdoc
index ef5d0cca4c..c763d587ae 100644
--- a/doc/qtcreator/src/howto/creator-keyboard-shortcuts.qdoc
+++ b/doc/qtcreator/src/howto/creator-keyboard-shortcuts.qdoc
@@ -234,7 +234,7 @@
             \li  Alt+O
         \row
             \li  Maximize output views
-            \li  Alt+9
+            \li  Alt+Shift+9
         \row
             \li  Move to next item in output
             \li  F6
diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
index e380c1e6e8..afc1450be8 100644
--- a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
@@ -96,7 +96,7 @@
     a build, detailed output from the compiler, status of a program when it is
     executed, debug output, or search results.
 
-    \image qtcreator-output-panes-taskbar.png "Output on the taskbar"
+    \image qtcreator-output-panes-taskbar.webp "Output on the taskbar"
 
     To view different types of output, use the following shortcuts:
 
diff --git a/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc b/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
index b2dc857e45..a782558ebd 100644
--- a/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
@@ -239,7 +239,9 @@
     For console applications that require input, select \uicontrol Projects >
     \uicontrol {Run Settings} > \uicontrol {Run in terminal}. To specify the
     terminal to use, select \uicontrol Edit > \uicontrol Preferences >
-    \uicontrol Environment > \uicontrol System.
+    \uicontrol Environment > \uicontrol System. To use an \l{Terminal}
+    {internal terminal}, select \uicontrol Edit > \uicontrol Preferences
+    > \uicontrol Terminal > \uicontrol {Use internal terminal}.
 
     \b {On Windows:} Output is displayed differently for \e{console
     applications} and \e{GUI applications}.
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc
index 27fe9ade25..c3f3688e89 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc
@@ -21,7 +21,10 @@
 
     For console applications, check the \uicontrol{Run in terminal} check box.
     To specify the terminal to use on Linux and \macos, select \uicontrol Edit
-    > \uicontrol Preferences > \uicontrol Environment > \uicontrol System.
+    > \uicontrol Preferences > \uicontrol Environment > \uicontrol System. To use
+    an \l{Terminal}{internal terminal}, select \uicontrol Edit >
+    \uicontrol Preferences > \uicontrol Terminal >
+    \uicontrol {Use internal terminal}.
 
     To run with special environment variables set up, select them in the
     \uicontrol {Run Environment} section. For more information, see
diff --git a/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc b/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc
index e47328e744..c8ef1ee206 100644
--- a/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc
+++ b/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc
@@ -60,7 +60,9 @@
         \li Open a terminal window in the selected directory or in the directory
             that has the file. To specify the terminal to use on Linux and
             \macos, select \uicontrol Edit > \uicontrol Preferences >
-            \uicontrol Environment > \uicontrol System.
+            \uicontrol Environment > \uicontrol System. To use an \l{Terminal}
+            {internal terminal}, select \uicontrol Edit > \uicontrol Preferences
+            > \uicontrol Terminal > \uicontrol {Use internal terminal}.
         \li Search from the selected directory.
         \li View file properties, such as name, path, MIME type, default editor,
             line endings, indentation, owner, size, last read and modified
diff --git a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc
index b0a98a8163..84453cf61b 100644
--- a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc
+++ b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc
@@ -84,6 +84,9 @@
         \li Open a terminal window in the project directory. To specify the
             terminal to use on Linux and \macos, select \uicontrol Edit >
             \uicontrol Preferences > \uicontrol Environment > \uicontrol System.
+            To use an \l{Terminal}{internal terminal}, select \uicontrol Edit >
+            \uicontrol Preferences > \uicontrol Terminal >
+            \uicontrol {Use internal terminal}.
         \li Open a terminal window in the project directory that you configured
             for building or running the project.
         \li Expand or collapse the tree view to show or hide all files and
diff --git a/doc/qtcreator/src/user-interface/creator-ui.qdoc b/doc/qtcreator/src/user-interface/creator-ui.qdoc
index 315720275a..c4ba6cad41 100644
--- a/doc/qtcreator/src/user-interface/creator-ui.qdoc
+++ b/doc/qtcreator/src/user-interface/creator-ui.qdoc
@@ -376,13 +376,17 @@
 
     \list
 
-       \li \uicontrol{Issues}
+       \li \l {Issues}
 
-       \li \uicontrol{Search Results}
+       \li \l {Search Results}
 
-       \li \uicontrol{Application Output}
+       \li \l {Application Output}
 
-       \li \uicontrol{Compile Output}
+       \li \l {Compile Output}
+
+       \if defined(qtcreator)
+       \li \l {Terminal}
+       \endif
 
        \li \uicontrol {QML Debugger Console}
 
@@ -396,7 +400,7 @@
        \li \l{Using Squish}{Squish} test results and Squish Server and
             Runner logs
 
-       \li \uicontrol {To-Do Entries}
+       \li \l {To-Do Entries}
 
        \endif
 
@@ -404,7 +408,7 @@
 
     Output is available on the taskbar in all \l{Selecting Modes}{modes}.
 
-    \image qtcreator-output-panes-taskbar.png "Output on the taskbar"
+    \image qtcreator-output-panes-taskbar.webp "Output on the taskbar"
 
     You can view output in the following ways:
 
@@ -415,7 +419,8 @@
         \li Select \inlineimage icons/output-pane-menu.png
             , and then select the view to open.
         \li Select \uicontrol View > \uicontrol Output.
-            The menu items also display the keyboard shortcuts that you can use.
+            The menu items also display the \l{Keyboard Shortcuts}
+            {keyboard shortcuts} that you can use.
     \endlist
 
     To maximize an open output view, select the \inlineimage icons/arrowup.png
@@ -644,6 +649,101 @@
     \endlist
 
     \if defined(qtcreator)
+
+    \section1 Terminal
+
+    When you select the \uicontrol {Run in Terminal} check box and run an
+    application or the \uicontrol {Open Terminal} button to open a terminal,
+    the default terminal opens. On Linux and \macos, you can set the default
+    terminal by selecting \uicontrol Edit > \uicontrol Preferences >
+    \uicontrol Environment > \uicontrol System.
+
+    To open the terminal on the taskbar instead of in a separate window, select
+    \uicontrol Edit > \uicontrol Preferences > \uicontrol Terminal >
+    \uicontrol {Use internal terminal}.
+
+    \image qtcreator-output-terminal.webp {Terminal pane}
+
+    To clear the terminal, select \inlineimage icons/clean_pane_small.png
+    (\uicontrol Clear).
+
+    To close the current terminal, select \inlineimage icons/terminal-close.png
+    .
+
+    To open new terminals as tabs, select \inlineimage icons/terminal-create.png
+    .
+
+    To move between terminals, select the tabs or \inlineimage icons/arrowup.png
+    and \inlineimage icons/arrowdown.png
+    .
+
+    To select a word in a terminal, double-click it. To select the whole line,
+    triple-click it.
+
+    To open links in a browser, files in the editor, or folders in the
+    \l Projects view, hover the mouse over them, and press \key Ctrl.
+
+    To \l{Finding and Replacing}{search} through the output, press \key {Ctrl+F}.
+
+    To make the font larger or smaller, select the \inlineimage icons/plus.png
+    and \inlineimage icons/minus.png
+    buttons. You can also change the font size in terminal preferences.
+
+    To open terminal preferences, select \inlineimage icons/settings.png
+    (\uicontrol Configure).
+
+    Most of the \QC keyboard shortcuts are disabled in the terminal, except the
+    ones for opening terminal preferences or the locator and quitting \QC. To
+    send the escape key to the terminal instead of closing the terminal, select
+    \uicontrol {Shift+Esc}. You can also specify that the escape key is sent to
+    the terminal in terminal preferences.
+
+    \section2 Setting Terminal Preferences
+
+    To set preferences for the internal terminal, select \uicontrol Edit >
+    \uicontrol Preferences > \uicontrol Terminal, or select the
+    \uicontrol Configure button in the \uicontrol Terminal pane.
+
+    \image qtcreator-preferences-terminal.webp {Terminal tab in Preferences}
+
+    \table
+    \header
+        \li Option
+        \li Value
+    \row
+        \li \uicontrol {Use internal terminal}
+        \li Open the \uicontrol Terminal pane when you select
+            \uicontrol {Run in Terminal} or \uicontrol {Open Terminal}.
+    \row
+        \li \uicontrol {Send escape key to terminal}
+        \li Send the escape key to the terminal instead of closing the terminal.
+    \row
+        \li \uicontrol {Audible bell}
+        \li Play an audible bell when the a bell character is received.
+    \row
+        \li \uicontrol {Allow blinking cursor}
+        \li Allow the cursor to blink.
+    \row
+        \li \uicontrol {Font}
+        \li Select the \uicontrol {Font family} and \uicontrol Size for the text
+            in the terminal. You can also use the \inlineimage icons/plus.png
+            and \inlineimage icons/minus.png buttons in the \uicontrol Terminal
+            pane to change the font size.
+    \row
+        \li \uicontrol {Colors}
+        \li Set colors for the \uicontrol Terminal pane \uicontrol Foreground,
+            \uicontrol Background, \uicontrol Selection, and
+            \uicontrol {Find match}.
+    \row
+        \li \uicontrol {Default shell}
+        \li Set the full path to the default terminal executable in
+            \uicontrol {Shell path} and the arguments to pass to the shell
+            in \uicontrol {Shell arguments}.
+    \endtable
+
+    To use an existing color scheme, select \uicontrol {Load Theme}. To revert
+    color changes, select \uicontrol {Reset Theme}.
+
     \section1 To-Do Entries
 
     \uicontrol {To-Do Entries} lists the BUG, FIXME, NOTE, TODO, and