From f2f3564595f510da6125841586f2896d1f1901ee Mon Sep 17 00:00:00 2001 From: Kurt Hindenburg Date: Sat, 9 Jul 2016 21:14:02 -0400 Subject: [PATCH] Update manual and misc doc updates Update remote tab tokens; remove outdated dbus comment. --- doc/manual/README | 2 +- doc/manual/index.docbook | 25 ++++--- doc/manual/kde4.notes | 141 --------------------------------------- 3 files changed, 18 insertions(+), 150 deletions(-) delete mode 100644 doc/manual/kde4.notes diff --git a/doc/manual/README b/doc/manual/README index 7da1f1bf..926cde41 100644 --- a/doc/manual/README +++ b/doc/manual/README @@ -1,5 +1,5 @@ Use CheckXML to verify the file is valid XML -Use meinproc4 to create an HTML version. +Use meinproc5 to create an HTML version for local viewing. Remember to update the date and releaseinfo when you want the the translators to see the new version. diff --git a/doc/manual/index.docbook b/doc/manual/index.docbook index 888d26b5..f50d3c9c 100644 --- a/doc/manual/index.docbook +++ b/doc/manual/index.docbook @@ -38,14 +38,14 @@ &Jonathan.Singer; -200520082009201020112014 + 2005200820092010201120142016 &Kurt.Hindenburg; &FDLNotice; -2016-04-18 -Applications 16.04 +2016-07-09 +Applications 16.08 &konsole; is &kde;'s terminal emulator. @@ -961,16 +961,26 @@ These changes can be made permanent by editing the current profile. -&konsole; will substitute these tokens: +&konsole; will substitute these tokens for local tabs: %n : program name %d : current directory (short) %D : current directory (long) +%h : local host (short) +%u : user name %w : window title set by shell %# : session number -%u : user name -%h : local host or remote host (short) -%H : remote host (long) + + +&konsole; will substitute these tokens for remote tabs: + + %c : current program + %h : remote host (short) + %H : remote host (long) + %u : user name + %U : user name@ (if given) + %w : window title set by shell + %# : session number @@ -1235,7 +1245,6 @@ will display the &DBus; interface for &konsole;. will display methods for controlling window 1. -/Konsole was previously used for controlling the first window, which is a design mistake. Please do not use it for that purpose anymore, and consider updating existing scripts. diff --git a/doc/manual/kde4.notes b/doc/manual/kde4.notes deleted file mode 100644 index 89235086..00000000 --- a/doc/manual/kde4.notes +++ /dev/null @@ -1,141 +0,0 @@ - - Konsole's interface ( particularly the menus and settings ) have - changed in KDE 4. These are notes on what needs to be covered - in the handbook and somewhere to draft a layout for the documentation. - - -- Robert Knight (robertknight@gmail.com) - ------------ -khindenburg - Aug 2008 -The handbook has been updated to trunk/ which will be 4.2. -The menus and command-line options are correct. -There is room for more information which could include some of the ideas below. -Also a FAQ section needs to be added. -Consider adding link to updated Handbook on konsole.kde.org -Consider what to do with konsole.kde.org ------------ - - Introduction - - What is Konsole? - - What is a terminal? - - How can I learn to use the terminal? - - Ideas: - - -> Information on more beginner-friendly shells such as Fish - -> Basic introduction? - -> Links to beginners tutorial for Bash shell - -> Links to information on scripting languages - -> Links to information on Vim, Emacs etc. - - - ( Konsole features )? - - A brief list of useful features in Konsole with links - to the appropriate section of the handbook. - - Basic Usage - - Creating new tabs - - Creating new windows - - Closing a tab or window - - Input - - Keyboard - - Mouse - - Opening links and email addresses - - Edit actions - - Copy and Paste - - Tab titles and renaming the tab - - Copying input to all tabs - - Scrolling - - Scrolling output - - With the mouse - - With the keyboard - - Clearing the display - - Clearing the current display only - - Clearing everything - - Changing the scroll-back size - - Searching output - - Saving output - - View actions - - Changing the text size temporarily - - Splitting the view - - Uses of split view - - What happens when the view is split? - - How to split the view: Left/Right , Top/Bottom - - Closing (unsplitting) the view: Close active view, close others - - Changing the size of the views - - Using the mouse - - Using the keyboard shortcuts - - Monitoring for silence or activity - - Hiding the menu bar - - Full screen mode - - Entering into and exiting from - - - Moving a tab between windows - - Bookmarks - - Creating a new bookmark - - Bookmarking a set of tabs as a folder - - Local vs SSH bookmarks - - Konsole Setup : Profiles - - - What is a profile - - Changing the current profile in a tab - - Editing the current profile - - General - - Name - - Command - - Working directory - - Icon - - Environment editor - - The $TERM environment variable - - Menu Bar display - - Tabs - - Tab titles - - Local vs Remote - - Inserting dynamic elementss - - Tab bar position - - Tab bar display mode - - Color Schemes and Fonts - - Choosing and previewing a color scheme - - Changing the text size - - Changing the font - - (Link -> Color Schemes) - - - Scrollback - - Scroll back types ( none , fixed line count , unlimited ) - - Scroll bar position - - Keyboard Setup - - Choosing a keyboard binding - - (Link -> Keyboard Bindings) - - - Advanced - - Managing profiles - - Creating new profiles - - Creating a new session from a profile - - Editing existing profiles - - Removing profiles - - Favorite profiles - - Profile shortcuts - - Color Schemes - - Creating new color schemes - - The color palette - - Changing a color - - Transparent color schemes - -> Transparency requirements - - Randomly varied background colors - - Editing existing color schemes - - Removing color schemes - - Keyboard Bindings - - Creating a new keyboard binding - - Editing key binding entries - - Key sequence specification - - Output specification - - Escape characters - - Adding a new key binding - - Removing a key binding - - Testing key bindings - - Editing existing bindings - - Removing bindings