[gentoo-commits] proj/ufed:master commit in: /

[Sven Eden]

commit:     480c846b9efe02fc772193d36b24de0ba452c3e6
Author:     Sven Eden <yamakuzure <AT> gmx <DOT> net>
AuthorDate: Wed Feb 26 09:05:36 2014 +0000
Commit:     Sven Eden <sven.eden <AT> gmx <DOT> de>
CommitDate: Wed Feb 26 09:05:36 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/ufed.git;a=commit;h=480c846b

Updated the documentation for 0.91 release.

---
 TODO               |  4 ++--
 ufed-curses-help.c | 15 +++++++++++----
 ufed.8.in          | 24 ++++++++++++++++--------
 3 files changed, 29 insertions(+), 14 deletions(-)

diff --git a/TODO b/TODO
index f1d5283..0b74593 100644
--- a/TODO
+++ b/TODO
@@ -46,7 +46,7 @@ These have been finished :
     Compilation failed in require at /usr/sbin/ufed line 9.
     BEGIN failed--compilation aborted at /usr/sbin/ufed line 9.
 - (0.90) Filter masked flags reliably.
-- (0.90) Add an option to re-show masked USE flags, but in parantheses.
+- (0.90) Add an option to re-show masked USE flags, but in parentheses.
 - (0.90) Add toggling package list display.
 - (0.90) Handle setups where /etc/portage/make.conf is a directory.
 - (0.90) Read PORTDIR and PORTDIR_OVERLAY from portageq, too.
@@ -56,6 +56,6 @@ These have been finished :
 - (0.91) Make key help buttons dynamic (text, placement and width).
 - (0.91) Replace status indicator with dynamic status line.
 - (0.91) ufed does not error out when USE in make.conf is exceptionally large.
-- (0.91) The deprecated 'portageq envvar' is no longer used for to determine
+- (0.91) The deprecated 'portageq envvar' is no longer used to determine
          PORTDIR and PORTDIR_OVERLAY, eix is used if available and portageq
          with the get_repo(s|_path) command as a fallback.

diff --git a/ufed-curses-help.c b/ufed-curses-help.c
index ea0c586..e627166 100644
--- a/ufed-curses-help.c
+++ b/ufed-curses-help.c
@@ -120,7 +120,9 @@ static void init_lines(void)
 "",
 "ufed will present you with a list of descriptions for each USE flag. If a "
 "description is too long to fit on your screen, you can use the Left and Right "
-"arrow keys to scroll the descriptions.",
+"arrow keys to scroll the descriptions. Alternatively you can change the "
+"description to show a reduced variant using the F10 key, or change the "
+"display to wrap long lines into multiple lines using the F11 key.",
 "",
 "Use the Up and Down arrow keys, the Page Up and Page Down keys, the Home and "
 "End keys, or start typing the name of a flag to select it.",
@@ -147,6 +149,8 @@ static void init_lines(void)
 "",
 " F10: Toggle whether to display the full description or a stripped version.",
 "",
+" F11: Enable / disable wrapping of long lines.",
+"",
 "The stripped version has various wordings like \"Enables support for\" or "
 "\"Build and install the\" at the beginning of the description removed.",
 "Although somewhat crippled, the descriptions key information then needs "
@@ -154,13 +158,13 @@ static void init_lines(void)
 "description, to determine a flags meaning without scrolling the text in most "
 "cases; even on low resolution displays.",
 "",
-"The default is to display the full description preceeded by the list of "
+"The default is to display the full description preceded by the list of "
 "affected packages.",
 "",
 "Below the list of descriptions an indicator line is displayed that shows the "
 "current setting of all filters and settings.",
 "The order and layout is:",
-"[Scope|State|Mask|Order|Description] with",
+"[Scope|State|Mask|Order|Description|Wrapping] with",
 "Scope:",
 "  glob : Global USE flags are shown.",
 "  loca : Local USE flags are shown.",
@@ -179,6 +183,9 @@ static void init_lines(void)
 "Description:",
 "  orig : The original full description is shown.",
 "  stri : The stripped version of the description is shown.",
+"Wrapping:",
+"  long : The original one-line layout with horizontal scrolling.",
+"  wrap : Wrapped lines that do not need horizontal scrolling.",
 "",
 "If ncurses is installed with the \"gpm\" use flag enabled, you can use your "
 "mouse to navigate and to toggle the settings, too.",
@@ -246,7 +253,7 @@ static void init_lines(void)
 "file(s) and if it is a - then that flag was unset in that file(s).",
 "",
 "Flags marked as [+] or [-] will be saved in your make.conf when you leave "
-"the program with an Enter.",
+"the program by hitting the 'Enter' key",
 "",
 "You can change the order of the (packages) and the description with the F9 "
 "key.",

diff --git a/ufed.8.in b/ufed.8.in
index 59cbfaa..6ed3cc1 100644
--- a/ufed.8.in
+++ b/ufed.8.in
@@ -1,12 +1,12 @@
-.TH "UFED" "8" "09 Apr 2013" "UFED 0.90" "UFED"
+.TH "UFED" "8" "26 Feb 2014" "UFED 0.91" "UFED"
 .SH "NAME"
 ufed \- Gentoo Linux USE flags editor
 .SH "SYNOPSIS"
 .B ufed 
 .SH "INTRODUCTION"
-UFED is a simple program designed to help you configure the
-systems USE flags (see below) to your liking. To enable or
-disable a flag highlight it and hit space.
+UFED is a simple program designed to help you configure the systems USE flags
+(see below) to your liking. To enable or disable a flag highlight it and hit
+space.
 
 ufed edits the USE flag settings in your make.conf file only. It can not be
 used to edit your package.use file.
@@ -91,7 +91,9 @@ or 'f' in the defaults column (see "Display layout" below) indicates this.
 
 ufed will present you with a list of descriptions for each USE flag. If a
 description is too long to fit on your screen, you can use the Left and Right
-arrow keys to scroll the descriptions.
+arrow keys to scroll the descriptions. Alternatively you can change the
+description to show a reduced variant using the F10 key, or change the display
+to wrap long lines into multiple lines using the F11 key.
 
 Use the Up and Down arrow keys, the Page Up and Page Down keys, the Home and
 End keys, or start typing the name of a flag to select it.
@@ -117,6 +119,8 @@ will change to.
 F9: Toggle the order of the affected package list and the description.
 .br
 F10: Toggle whether to display the full description or a stripped version.
+.br
+F11: Enable / disable wrapping of long lines.
 
 The stripped version has various wordings like "Enables support for" or
 "Build and install the" at the beginning of the description removed.
@@ -125,7 +129,7 @@ less space and allows, with switched order of the package list and the
 description, to determine a flags meaning without scrolling the text in most
 cases; even on low resolution displays.
 
-The default is to display the full description preceeded by the list of
+The default is to display the full description preceded by the list of
 affected packages.
 
 Below the list of descriptions an indicator line is displayed that shows the
@@ -133,7 +137,7 @@ current setting of all filters and settings.
 .br
 The order and layout is:
 .br
-[Scope|State|Mask|Order|Description] with
+[Scope|State|Mask|Order|Description|Wrapping] with
 .br
 Scope:
   glob : Global USE flags are shown.
@@ -157,6 +161,10 @@ Order:
 Description:
   orig : The original full description is shown.
   stri : The stripped version of the description is shown.
+.br
+Wrapping:
+  long : The original one-line layout with horizontal scrolling.
+  wrap : Wrapped lines that do not need horizontal scrolling.
 
 If ncurses is installed with the "gpm" use flag enabled, you can use your
 mouse to navigate and to toggle the settings, too.
@@ -230,7 +238,7 @@ set in that file(s), if it is a space then the flag was not mentioned in that
 file(s) and if it is a - then that flag was unset in that file(s).
 
 Flags marked as [+] or [-] will be saved in your make.conf when you leave the
-program with an Enter.
+program by hitting the 'Enter' key.
 
 You can change the order of the (packages) and the description with the F9 key.