Merge pull request #16 from tgsachse/v1.1.1

Tiger Sachse · Tiger Sachse · commit da6dbad03e32 · 2018-01-09T17:52:59.000-05:00
V1.1.1
diff --git a/docs/CHANGES.txt b/docs/CHANGES.txt
@@ -1,5 +1,8 @@
 Changelog for Shellcuts
 
+v1.1.1 - 01/08/2018
+  - Added manual page
+
 v1.1.0 - 01/03/2018
   - Renamed to Shellcuts for universality
   - Revamped readme
diff --git a/docs/PYPI_DESCRIPTION.txt b/docs/PYPI_DESCRIPTION.txt
@@ -0,0 +1 @@
+Please see the GitHub project page for more information, located at https://www.github.com/tgsachse/shellcuts
diff --git a/docs/README.rst b/docs/README.rst
@@ -1,23 +1,20 @@
 shellcuts - directory shortcuts for your shell
 ----------------------------------------------
 
-Shellcuts allow you to save locations in your filesystem and jump to those locations later with a simple command (much like bookmarks). This program aims to include what other, similar programs are missing, and acts as a drop-in replacement for Bashmarks_ and `other-shell derivatives`_. Shellcuts includes the following features:
+Shellcuts are directory shortcuts for your shell. This program allows you to save locations as 'shellcuts' and then cut back to those locations with a single, short command. This program is inspired by Bashmarks and hopes to improve on Bashmarks_ by supporting more systems and shells. Shellcuts includes the following features:
 
 - creates named shellcuts to any location in the filesystem
 - lists all saved shellcuts
 - deletes shellcuts by name
 - saves shellcuts on a per-user basis
 - supports Bashmarks syntax for user comfort and familiarity
-- written mostly in Python for portability
-- supports Bash shell
-- installable via Pip
 
 Planned features include:
 
 - tab completion
 - Fish, Zsh, Csh, Korn shell support
 - installable via APT, Homebrew
-- possibly include z-like_ functionality
+- z-like_ features
 
 installation
 ------------
@@ -51,12 +48,12 @@ If, for whatever reason, the other methods don't work for you or maybe just aren
 
 usage
 -----
-When you first install Shellcuts, you must run the program initialization script once to finish configuration. Simply run this command to launch the configuration utility:
+When you first install Shellcuts, you must initialize the program once before it can be used. Run this command to launch the configuration utility:
 ::
   $ sc-init
-The configuration utility will give you the option to automatically configure your system to use Shellcuts, or it will tell you how to do the configuration manually. I highly recommend using the automatic configuration, as it's not prone to human error and is designed to make setup super easy!
+The configuration utility will automatically configure your system, or if you'd prefer it can show you how to do the configuration manually. It's highly recommended that you use the automatic configuration, as it's safe from human error and is really easy!
 
-The core command for Shellcuts is ``sc``. By default, Shellcuts includes these aliases for ``sc``:
+The core command for Shellcuts is ``sc`` and by default this program includes the aliases:
 
 - ``shellcut``
 - ``shellcuts``
@@ -73,26 +70,28 @@ Feel free to use any of the above or the main ``sc`` command to operate Shellcut
 
 Here is a list of all available options/flags:
 
-NEW: ``-n, --new [name]``
-  Add a shellcut for the current working directory, named *name*.
-DELETE: ``-d, --delete [name]``
-  Delete shellcut named *name* if it exists.
-PRINT: ``-p, --print [name]``
-  Print the location saved by the shellcut named *name*.
+DELETE: ``-d, --delete [shellcut]``
+  Delete the specified shellcut if it exists.
+(planned) HELP: ``-h, --help``
+  Display a help menu for quick reference.
 LIST: ``-l, --list``
   List all available shellcuts.
+NEW: ``-n, --new [shellcut]``
+  Create a new shellcut for the current working directory.
+PRINT: ``-p, --print [shellcut]``
+  Print the specified shellcut to the screen.
 (planned) VERSION: ``-v, --version``
-  Get Shellcuts version information.
+  Display version information.
+(planned) BASHMARKS SYNTAX: ``--enable-bashmarks-syntax, --disable-bashmarks-syntax``
+  Enable or disable Bashmarks syntax. (default: enabled)
 (planned) Z SETTINGS: ``--enable-z, --disable-z``
-  Enable or disable z-like features.
+  Enable or disable z-like features. (default: enabled)
 (planned) REINITIALIZE: ``--init``
-  Rerun the initial setup script.
-(planned) HELP: ``-h, --help``
-  Launch a help menu.
+  Launch the initialization script.
   
 examples
 --------
-Here are some examples of Shellcuts in action.
+Here are some examples of Shellcuts in action. See this program's man page for more.
 ::
   $ pwd                               # Show current directory
   /home/tgsachse/Downloads
@@ -121,7 +120,6 @@ Here are some examples of Shellcuts in action.
   bin : /bin
 
 .. _Bashmarks: https://www.github.com/huyng/bashmarks
-.. _`other-shell derivatives`: https://github.com/search?utf8=%E2%9C%93&q=bashmarks&type=
 .. _z-like: https://github.com/rupa/z
 .. _`Python 3`: https://www.python.org
 .. _Pip: https://pip.pypa.io/en/stable/
diff --git a/docs/shellcuts.1 b/docs/shellcuts.1
@@ -0,0 +1,214 @@
+.TH shellcuts 1 "8 January 2018" "1.1.1"
+
+.SH NAME
+shellcuts - directory shortcuts for your shell.
+
+.SH SYNOPSIS
+sc [shellcut] [-flag] [flag option]
+
+.SH DESCRIPTION
+Shellcuts are directory shortcuts for your shell. This program allows you to save locations as 'shellcuts' and then cut back to those locations with a single, short command. This program is inspired by Bashmarks and hopes to improve on Bashmarks by supporting more systems and shells. Shellcuts includes the following features:
+.PP
+.RS 2
+- create named shellcuts to any location in the filesystem
+.PP
+- list all saved shellcuts
+.PP
+- delete shellcuts by name
+.PP
+- save shellcuts on a per-user basis
+.PP
+- support Bashmarks syntax for user comfort and familiarity
+.RE
+.PP
+Planned features include:
+.RS 2
+.PP
+- tab completion
+.PP
+- Fish, Zsh, Csh, Korn shell support
+.PP
+- z-like features
+.RE
+
+.SH OPTIONS
+.B  -d, --delete 
+.I shellcut
+.RS 4
+delete the specified shellcut if it exists
+.RE
+.PP
+.B -h, --help
+.RS 4
+display a help menu for quick reference
+.RE
+.PP
+.B -l, --list
+.RS 4
+list all available shellcuts
+.RE
+.PP
+.B -n, --new
+.I shellcut
+.RS 4
+create a new shellcut for the current working directory
+.RE
+.PP
+.B -p, --print
+.I shellcut
+.RS 4
+print the specified shellcut to the screen
+.RE
+.PP
+.B -v, --version:
+display version information
+.RE
+.PP
+.B --enable-bashmarks-syntax, --disable-bashmarks-syntax
+.RS 4
+enable or disable Bashmarks syntax (default: enabled)
+.RE
+.PP
+.B --enable-z, --disable-z
+.RS 4
+enable or disable z-like features (default: enabled)
+.RE
+.PP
+.B --init
+.RS 4
+launch the initialization script
+.RE
+
+.SH USAGE
+When you first install Shellcuts, you must initialize the program once before it can be used. Run this command to launch the configuration utility:
+.PP
+.RS 2
+.I sc-init
+.RE
+.PP
+The configuration utility will automatically configure your system, or if you'd prefer it can show you how to do the configuration manually. It's highly recommended that you use the automatic configuration, as it's safe from human error and is really easy!
+.PP
+The core command for Shellcuts is 
+.I sc
+and by default this program includes the following aliases:
+.PP
+.RS 2
+-
+.I shellcut
+.PP
+-
+.I shellcuts
+.PP
+-
+.I shellc
+.PP
+-
+.I scut
+.PP
+.RE
+Feel free to use any of the above or the main
+.I sc
+command to operate Shellcuts. This program also includes aliases to replicate Bashmarks syntax. They are as follows:
+.PP
+.RS 2
+-
+.I d
+to delete, equivalent to
+.I sc -d
+.PP
+-
+.I g
+to go, equivalent to
+.I sc
+.PP
+-
+.I l
+to list, equivalent to
+.I sc -l
+.PP
+-
+.I p
+to print, equivalent to
+.I sc -p
+.PP
+-
+.I s
+to save, equivalent to
+.I sc -n
+.RE
+
+.SH EXAMPLES
+Save a shellcut named
+.I downloads
+using the user's current directory:
+.PP
+.RS 4
+.I sc -n downloads
+.RE
+.PP
+Go to the shellcut named
+.I downloads
+if it exists:
+.PP
+.RS 4
+.I sc downloads
+.RE
+.PP
+List all saved shellcuts:
+.PP
+.RS 4
+.I sc -l
+.RE
+.PP
+Delete shellcut named
+.I binaries
+if it exists:
+.PP
+.RS 4
+.I sc -d binaries
+.RE
+.PP
+Print shellcut named
+.I home
+if it exists:
+.PP
+.RS 4
+.I sc -p home
+.RE
+.PP
+Save a new shellcut named
+.I downloads
+using Bashmarks syntax, then print the same shellcut:
+.PP
+.RS 4
+.I s downloads
+.PP
+.I p downloads
+.RE
+.PP
+Go to shellcut named
+.I pictures
+using an
+.I sc
+alias:
+.PP
+.RS 4
+.I scut pictures
+.RE
+
+.SH FILES
+.B ~/.config/shellcuts/shellcuts.sh
+.RS 4
+storage location for all shellcuts
+.RE
+
+.SH LICENSE
+GPLv3
+
+.SH SOURCE
+Visit
+.I https://www.github.com/tgsachse/shellcuts
+to view the source code for this program and give the project a star if you really liked it!
+
+.SH AUTHOR
+Tiger Sachse (tgsachse)
diff --git a/setup.py b/setup.py
@@ -12,25 +12,21 @@
 Legal:
     Author: Tiger Sachse
     License: GPLv3
-    Version: 1.1.0
+    Version: 1.1.1
     Initial Release: 12/31/2017
-    Current Release: 01/02/2018
+    Current Release: 01/08/2018
 """
-
-from setuptools import setup
-
-F_DESCRIPTION = 'docs/README.rst'
+LONG_DESCRIPTION = 'docs/PYPI_DESCRIPTION.txt'
 
 def load_long_description():
-    """Load description for PyPI from file"""
-    with open(F_DESCRIPTION, 'r') as f:
-        long_description = f.read()
+    with open(LONG_DESCRIPTION, 'r') as f:
+        return f.read()
 
-    return long_description
+from setuptools import setup
 
 setup(
     name='shellcuts',
-    version='1.1.0',
+    version='1.1.1.1',
     author='Tiger Sachse',
     description='Directory shortcuts for your shell.',
     long_description=load_long_description(),
@@ -55,9 +51,10 @@ def load_long_description():
     python_requires='>=3',
     data_files=[
         ('bin', ['shellcuts/sc-handler',
-                 'shellcuts/sc-init',
-                 'shellcuts/shellcuts.sh']),
+                 'shellcuts/sc-init']),
+        ('share/shellcuts', ['shellcuts/shellcuts.sh']),
         ('share/doc/shellcuts', ['docs/CHANGES.txt',
                                  'docs/LICENSE.txt',
-                                 'docs/README.rst'])]
+                                 'docs/README.rst']),
+        ('share/man/man1',['docs/shellcuts.1'])]
 )
diff --git a/shellcuts/sc b/shellcuts/sc
diff --git a/shellcuts/sc-handler b/shellcuts/sc-handler
@@ -24,9 +24,9 @@ Returns:
 Legal:
     Author: Tiger Sachse
     License: GPLv3
-    Version: 1.1.0
+    Version: 1.1.1
     Initial Release: 12/31/2017
-    Current Release: 01/02/2018
+    Current Release: 01/08/2018
 """
 
 import os
diff --git a/shellcuts/sc-init b/shellcuts/sc-init

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Please see the GitHub project page for more information, located at https://www.github.com/tgsachse/shellcuts`