Merge pull request #94 from roberthawdon/develop

0.7.0 Develop to Master

README.rst

@@ -186,10 +186,10 @@ Screenshots
 
 **SF - Show File**
 
-.. image:: https://user-images.githubusercontent.com/4301139/52901918-bc7a5280-3201-11e9-809b-94698ab29d1a.png
+.. image:: https://user-images.githubusercontent.com/4301139/56430876-c121bc80-62bf-11e9-9ac3-d892d8f37acb.png
    :alt: Show File
 
 **Colors (Built into Show)**
 
-.. image:: https://user-images.githubusercontent.com/4301139/52901920-bd12e900-3201-11e9-93d5-1b1f77fde49e.png
+.. image:: https://user-images.githubusercontent.com/4301139/56430881-c2eb8000-62bf-11e9-978b-3fda6f8cb0f3.png
    :alt: Colors

configure.ac

@@ -1,4 +1,4 @@
-AC_INIT([dfshow], [0.6.4], [https://github.com/roberthawdon/dfshow/issues])
+AC_INIT([dfshow], [0.7.0], [https://github.com/roberthawdon/dfshow/issues])
 AC_GNU_SOURCE
 AM_INIT_AUTOMAKE([subdir-objects])
 AC_PROG_CC

docs/source/conf.py

@@ -26,7 +26,7 @@
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-release = '0.6.4-alpha'
+release = '0.7.0-alpha'
 
 
 # -- General configuration ---------------------------------------------------

docs/source/installation.rst

@@ -97,9 +97,9 @@ Building from Source
 Ensure you have the following dependencies installed:
 
 * Your system's build tools
-* gcc
-* ncurses development packages
-* libconfig development packages
+* A C compiler (``gcc`` or ``clang``)
+* ``ncurses`` development packages
+* ``libconfig`` development packages
 
 Download the project and prepare sources.
 

docs/source/sf.rst

@@ -21,7 +21,7 @@ The identification line gives the line and column number of the top
 left character in the window. An example of the command line and
 information line is given below.
 
-``F1-Down, F2-Up, F3-Top, F4-Bottom, Find, Help, Position, Quit, Wrap-on``
+``F1-Down, F2-Up, F3-Top, F4-Bottom, Config, Find, Help, Position, Quit, Wrap-on``
 
 ``File = /home/robert/sf.txt  Top = 1:1``
 
@@ -36,6 +36,9 @@ Command line arguments
 ``--theme``\ =[THEME]: Color themes. Passsing this argument
   without an option will display available themes.
 
+``--settings-menu``
+Launch ``sf`` directly into the settings menu.
+
 ``--help``: Displays help message, then exits.
 
 ``--version``: Displays program version, then exits.
@@ -67,6 +70,11 @@ described below.
   Bottom of File - Position the file window to the last line of the
   file.
 
+``Config``
+Launches ``sf``\ 's configuration menu. From here, all aspects of ``sf``
+can be configured, and settings saved so they will persist between sessions.
+Further information can be found in the `configuring sf <#configuring-sf>`__ section.
+
 ``Find``
   Searches for a string provided in the form of a Regex. Case
   sensitivity is requested by the following prompt, afterwards the
@@ -113,3 +121,32 @@ described below.
 
 ``End``
   Position the file window to the last column of the file.
+
+Configuring sf
+--------------
+``sf`` features an inbuilt configuration menu where the user can tweak
+the default settings. It is accessed using the Config command.
+
+The following screen is displayed.
+
+::
+
+   SF Settings Menu - Quit, Revert, Save
+
+      [ ] Enable text wrapping
+
+The menu is made up of toggle switches. When active, the switch will display
+``[*]``, when inactive ``[ ]`` is displayed. To toggle a value, press *SPACE*
+when the cursor is highlighed over a specific item.
+
+The following commands can be used within this menu.
+
+``Quit``
+Applies changes and either returns to the previous screen.
+
+``Revert``
+Reverts settings to their original value from when the settings menu was
+invoked.
+
+``Save``
+Saves settings for future sessions.

docs/source/show.rst

@@ -101,6 +101,12 @@ The following options are specific to ``show``:
   Checks for parent instances of ``show``, this is useful when using
   the Run Command option.
 
+``--settings-menu``
+  Launch ``show`` directly into the settings menu.
+
+``--edit-themes``
+  Launches ``show`` directly into the theme editor. (colors)
+
 Commands
 --------
 
@@ -524,7 +530,7 @@ invoke the editor for a fire, or terminate the application
 completely. The first character of the command is used to invoke the
 desired function. The command line is shown below.
 
-``cOlors, Edit file, Help, Make dir, Quit, Run command, Show dir, Touch file``
+``cOlors, Config, Edit file, Help, Make dir, Quit, Run, Show dir, Touch file``
 
 These commands are desctibed below.
 
@@ -534,9 +540,11 @@ These commands are desctibed below.
   Further information can be found in the `colors <#colors>`__
   section.
 
-``Run command``
-  Invoke your shell. The ``show`` application is still resident, so
-  the "exit" command will return to the application.
+``Config``
+  Launches `show`'s configuration menu. From here, all aspects of
+  ``show`` can be configured, and settings saved so they will persist
+  between sessions. Further information can be found in the
+  `configuring show <#configuring-show>`__ section.
 
 ``Edit file``
   Invoke the default text editor to edit the specified file. The
@@ -557,6 +565,10 @@ These commands are desctibed below.
 ``Quit``
   Terminate ``show``.
 
+``Run``
+  Invoke your shell. The ``show`` application is still resident, so
+  the "exit" command will return to the application.
+
 ``Show dir``
   Invoke the application to display another directory. The directory
   name is requrested by the following prompt. An empty response is
@@ -578,6 +590,60 @@ These commands are desctibed below.
   Selecting No will set the file's access and modification time to the current
   time.
 
+Configuring show
+----------------
+
+``show`` features an inbuilt configuration menu where the user can tweak
+the default settings. It is accessed from the global menu.
+
+The following screen is displayed.
+
+::
+
+   SHOW Settings Menu - Quit, Revert, Save
+
+      [ ] Display file colors
+      <-> Show marked file info: <never> <always> <auto>
+      <-> Sorting mode: <name> <date> <size> <unsorted>
+      [ ] Reverse sorting order
+      <-> Time style: <locale> <iso> <long-iso> <full-iso>
+      [ ] Show hidden files
+      [ ] Hide backup files
+      [ ] Use 3rd party pager over SF
+      [ ] Use SI units
+      [ ] Human readable sizes
+      [ ] Enter key acts like Show
+      < > Owner Column: <owner> <group> <author>
+
+There are three types of configuration items, each denoted with a different
+symbol:
+
+``[ ]``
+Indicates a toggle switch, when active, the switch will display ``[*]``.
+To toggle a value, press *SPACE* when the cursor is highlighed over a specific item.
+
+``<->``
+Indicates a single value option, the active item will be highlighted. To change
+the value, use either the arrow keys, or *SPACE* to toggle through each available
+option.
+
+``< >``
+Indicates a multi value option, the active items will be highlighted. To change
+their values, use the arrow keys to highlight the desired option and press
+*SPACE* to toggle its activation status.
+
+The following commands can be used within this menu.
+
+``Quit``
+Applies changes and either returns to the previous screen.
+
+``Revert``
+Reverts settings to their original value from when the settings menu was
+invoked.
+
+``Save``
+Saves settings for future sessions.
+
 Colors
 ======
 
@@ -589,7 +655,7 @@ The following screen is displayed after launch.
 
 ::
 
-   Color number, Load, Quit, Save, Toggle
+   Color number, Load, Quit, Save, Toggle, Use
 
        Command lines                            !-Default
        Display lines                            ?-Default Bold
@@ -599,15 +665,15 @@ The following screen is displayed after launch.
        Danger lines                             3-Brown
        Selected block lines                     4-Blue
        Highlight                                5-Magenta
-                                                6-Cyan
-                                                7-Light Gray
-                                                8-Dark Gray
-                                                9-Light Red
-                                                A-Light Green
-                                                B-Yellow
-                                                C-Light Blue
-                                                D-Light Magenta
-                                                E-Light Cyan
+       Text input                               6-Cyan
+       Directories                              7-Light Gray
+       Symbolic links                           8-Dark Gray
+       Orphened symbolic links                  9-Light Red
+       Executable files                         A-Light Green
+       Set user identification                  B-Yellow
+       Set group identification                 C-Light Blue
+       Sticky bit directory                     D-Light Magenta
+       Sticky bit directory - other writable    E-Light Cyan
                                                 F-White
 
 
@@ -650,6 +716,21 @@ below.
 ``Highlight``
   The color of the command/function keys.
 
+``Text input``
+  The color of input text lines.
+
+The following color settings are used when ``--color`` arguement is used.
+They are used to differentiate object status:
+
+``Directories``
+``Symbolic links``
+``Orphened symbolic links``
+``Executable files``
+``Set user identification``
+``Set group identification``
+``Sticky bit directory``
+``Sticky bit directory - other writable``
+
 After each of the colors have been changed to the desired color, the
 theme must be saved with the ``Save`` command. All the commands are
 described below.
@@ -671,3 +752,7 @@ described below.
 
 ``Toggle``
   Switches between foreground and background selection.
+
+``Use``
+  Sets the theme as the default to persist between sessions. The current
+  theme needs to be saved before this command can be used.

man/sf.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "SF" "1" "February 2019" "" ""
+.TH "SF" "1" "April 2019" "" ""
 .
 .SH "NAME"
 \fBsf\fR \- An interactive file viewer written for Unix\-like systems\.
@@ -21,6 +21,9 @@ DF\-SHOW: An interactive directory/file browser written for Unix\-like systems\.
 \fB\-\-theme\fR=[\fITHEME\fR]: Color themes\. Passsing this argument without an option will display available themes\.
 .
 .IP "\(bu" 4
+\fB\-\-settings\-menu\fR: Launch \fBsf\fR directly into the settings menu\.
+.
+.IP "\(bu" 4
 \fB\-\-help\fR: Displays help message, then exits\.
 .
 .IP "\(bu" 4
@@ -41,7 +44,7 @@ If the \fBsf\fR application is invoked without specifiing a file name, the follo
 The screen format is very simple with a command line at the top of the screen, a display window consisting of the middle rows of the screen, and a file identification line at the bottom of the window\. The identification line gives the line and column number of the top left character in the window\. An example of the command line and information line is given below\.
 .
 .P
-\fBF1\-Down, F2\-Up, F3\-Top, F4\-Bottom, Find, Help, Position, Quit, Wrap\-on\fR
+\fBF1\-Down, F2\-Up, F3\-Top, F4\-Bottom, Config, Find, Help, Position, Quit, Wrap\-on\fR
 .
 .P
 \fBFile = /home/robert/sf\.txt Top = 1:1\fR
@@ -69,6 +72,10 @@ Top of File \- Position the file window to the first line of the file\.
 Bottom of File \- Position the file window to the last line of the file\.
 .
 .TP
+\fBConfig\fR
+Launches \fBsf\fR\'s configuration menu\. From here, all aspects of \fBsf\fR can be configured, and settings saved so they will persist between sessions\. Further information can be found in the \fICONFIGURING SF\fR section\.
+.
+.TP
 \fBFind\fR
 Searches for a string provided in the form of a Regex\. Case sensitivity is requested by the following prompt, afterwards the user is asked to input the string to search\. To abort at this prompt, the \fIESC\fR key must be used\.
 .
@@ -114,6 +121,43 @@ Position the file window to the first column of the file\.
 \fBEnd\fR
 Position the file window to the last column of the file\.
 .
+.SH "CONFIGURING SF"
+\fBsf\fR features an inbuilt configuration menu where the user can tweak the default settings\. It is accessed using the Config command\.
+.
+.P
+The following screen is displayed\.
+.
+.P
+\fBSF Settings Menu \- Quit, Revert, Save\fR
+.
+.IP "" 4
+.
+.nf
+
+  [ ] Enable text wrapping
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The menu is made up of toggle switches\. When active, the switch will display \fB[*]\fR, when inactive \fB[ ]\fR is displayed\. To toggle a value, press \fISPACE\fR when the cursor is highlighed over a specific item\.
+.
+.P
+The following commands can be used within this menu\.
+.
+.TP
+\fBQuit\fR
+Applies changes and either returns to the previous screen\.
+.
+.TP
+\fBRevert\fR
+Reverts settings to their original value from when the settings menu was invoked\.
+.
+.TP
+\fBSave\fR
+Saves settings for future sessions\.
+.
 .SH "AUTHOR"
 Written by Robert Ian Hawdon\.
 .