Spelling corrections and empty space cleanup.
authorctimmers07@139f6d7ae93821c8e82218a07e9d4cefba8033b4 <ctimmers07@web>
Thu, 17 May 2018 19:00:51 +0000 (19:00 +0000)
committerIkiWiki <ikiwiki.info>
Thu, 17 May 2018 19:00:51 +0000 (19:00 +0000)
docs/docs/howtos/howtoslide/index.mdwn

index 4eef522..f2f6226 100644 (file)
@@ -5,7 +5,7 @@ The purpose of this document is to demonstrate how to use the Slider utility to
 
 # Installing Slider
 
-The HAMMER file system time slider utility is available via dports, thus in can be installed by either binary package or by building from source.
+The HAMMER file system time slider utility is available via dports, thus it can be installed by either binary package or by building from source.
 
 ##  packages
 
@@ -19,7 +19,7 @@ If building from source is desired, you may wish to consider installing the Ada
 
        # pkg ins gcc-aux
 
-However, this step is optional.  It will be build automatically when the next command is invoked:
+However, this step is optional. It will be built automatically when the next command is invoked:
 
        # cd /usr/dports/sysutils/slider ; make install
 
@@ -53,23 +53,23 @@ However, this step is optional.  It will be build automatically when the next co
        Error: There is no current file with that name, nor is has any trace of a
        deleted version of '/root/nonexistant-file' being found.
 
-You might also see this error if the file was on a non-HAMMER filesystem, or the HAMMER filesystem has had it's history wiped either forcibly or through normal schedule maintenance.
+You might also see this error if the file was on a non-HAMMER filesystem, or if the HAMMER filesystem has had it's history wiped either forcibly or through normal schedule maintenance.
 
 ## Specifying an existing file that has no historical versions available
 
        # slider /var/log/slip.log
        Sorry, this file has no previous version available.
 
-## specifying an existing directory that doesn't contain deleted entries
+## Specifying an existing directory that doesn't contain deleted entries
 
        # slider /home/marino
        Sorry, no deleted entries were detected in this directory.
 
-Slider will scan the directory for records of deleted files or subdirectories.  Failure to find even a single record results in the message above.
+Slider will scan the directory for records of deleted files or subdirectories. Failure to find even a single record results in the message above.
 
-# Browse historical versions of existing file
+# Browse historical versions of an existing file
 
-The default for the HAMMER filesystem is to create a daily snapshot of the pseudo-filesystem and then remove all versions that aren't captured by an existing snapshot.  That means the versions available to restore are all those that exist before the nightly maintenance and those those that exist on a snapshot.  It is common to see dozens of versions on a highly-edited file and on the next day see that list reduced to only a copy of versions.
+The default for the HAMMER filesystem is to create a daily snapshot of the pseudo-filesystem and then remove all versions that aren't captured by an existing snapshot. That means the versions available to restore are all those that existed before the nightly maintenance and those that exist on a snapshot. It is common to see dozens of versions of a highly-edited file and on the next day see that list reduced to only a couple of versions.
 
 ## Get list of valid transactions
 
@@ -81,57 +81,57 @@ If historical versions are found, slider will display them in columns, and even
 
 ![version history](http://leaf.dragonflybsd.org/~marino/slider-img/file-with-history.03.png "Version history list")
 
-Note that this list could be shorter than what is produced by "hammer history".  That is because each version is checked to see if it is a valid inode that can be read.  It's not uncommon to run into bad transaction IDs, so they are filtered out for you.
+Note that this list could be shorter than what is produced by "hammer history". That is because each version is checked to see if it is a valid inode that can be read. It's not uncommon to run into bad transaction IDs, so they are filtered out for you.
 
 ## View the file if it is considered a text file
 
-Slider will pre-scan the existing version of the file using similar logic to "diff" and "svn" to determine if the file is a text file or a binary file.  If it detects that it is a text file, it will allow the file to be viewed minus unprintable characters.  To do this, simply use the arrow keys to select the timestamp desired and press the "F1" key.  This menu item will be brightly colored for text files and disabled in dark gray when it is a binary file.
+Slider will pre-scan the existing version of the file to determine if the file is a text file or a binary file using logic similar to "diff" and "svn". If it detects that it is a text file, it will allow the file to be viewed minus unprintable characters. To do this, simply use the arrow keys to select the timestamp desired and press the "F1" key. This menu item will be brightly colored for text files and disabled in dark gray when it is a binary file.
 
 ![View file text](http://leaf.dragonflybsd.org/~marino/slider-img/file-with-history.02.png "Viewing contents of historical version")
 
-The text file will be displayed.  The up and down arrow keys can be used to switch between pages.  If the file is longer than the equivalent of one hundred 80x22 pages, it will be truncated.  Note that files with a huge number of columns such as /usr/ports/INDEX-4 will only have a few pages due to this.  Press "F4" key when done viewing.
+The text file will be displayed. The up and down arrow keys can be used to switch between pages.  If the file is longer than the equivalent of one hundred 80x22 pages, it will be truncated. Note that files with a huge number of columns such as /usr/ports/INDEX-4 will only have a few pages due to this. Press "F4" key when done viewing.
 
 ## Viewing the difference between historical versions
 
-It is possible to view the difference between any two versions (current or historical) with either considered "original" or "changed".  The current version is considered the "original" file by default, and it is indicated by a bright white color.  The version that is back-lighted blue is considered the "changed" version, and this can be manipulated by selecting a different file with the arrow keys.  Pressing the ">" key will show the diff between them, and pressing the "<" will show the reverse diff between them.
+It is possible to view the difference between any two versions (current or historical) with either considered "original" or "changed". The current version is considered the "original" file by default, and it is indicated by a bright white color. The version that is back-lighted blue is considered the "changed" version, and this can be manipulated by selecting a different file with the arrow keys. Pressing the ">" key will show the diff between them, and pressing the "<" will show the reverse diff between them.
 
 ![View diff text](http://leaf.dragonflybsd.org/~marino/slider-img/file-with-history.04.png "Viewing difference between historical versions")
 
 The "diff" can be browsed via paged just as the contents can, and "F4" returns to the version list.
 
-In the event you don't want to include the current version of the file in the diff view, you can designate a different version as the "original" one.  All you do is use the arrow keys to select the desired "origin" version and press the "0" (zero) key.  That version will now display bright white and the arrow keys should be used to designate a new "changed" file for the diff view.
+In the event you don't want to include the current version of the file in the diff view, you can designate a different version as the "original" one. All you do is use the arrow keys to select the desired "origin" version and press the "0" (zero) key. That version will now display bright white and the arrow keys should be used to designate a new "changed" file for the diff view.
 
 ![change origin](http://leaf.dragonflybsd.org/~marino/slider-img/file-with-history.05.png "Showing the list after designating new origin file")
 
-## restoring an historical version to a new filename
+## Restoring a historical version to a new filename
 
-If slider doesn't receive a second argument which is a target path, it defines the target path as the original path plus ".restored" suffix.  Thus it is possible to quickly save a copy of the historical version of the file in a predictable place.  Just select the desired version and press the "F3" key to save it there.
+If slider doesn't receive a second argument which is a target path, it defines the target path as the original path plus ".restored" suffix. Thus it is possible to quickly save a copy of the historical version of the file in a predictable place. Just select the desired version and press the "F3" key to save it there.
 
 ![save as .restored](http://leaf.dragonflybsd.org/~marino/slider-img/file-with-history.06.png "Confirmation screen to save historical version to default location")
 
-You will be shown where the file will be saved.  To cancel, just hit "F4" key, otherwise hit the "F1" to save the file and exit Slider.  In the console you should see a success screen like the one below, but in a terminal emulator it might disappear before you see it.
+You will be shown where the file will be saved. To cancel, just hit "F4" key, otherwise hit the "F1" to save the file and exit Slider. In the console you should see a success screen like the one below, but in a terminal emulator it might disappear before you see it.
 
 ![save as success](http://leaf.dragonflybsd.org/~marino/slider-img/file-with-history.07.png "Success screen")
 
-## restoring an historical version to the current file
+## Restoring a historical version to the current file
 
-If you want to revert the specified file to an earlier version of itself, just select the "F2" (save) option.  You will get a similar confirmation and success screen, followed by Slider's exit.
+If you want to revert the specified file to an earlier version of itself, just select the "F2" (save) option. You will get a similar confirmation and success screen, followed by Slider's exit.
 
 # Scan directory to fully restore a deleted directory
 
-It is possible to completely restore a deleted directory assuming the parent directory exists.  To do this, pass the name of the parent directory to slider and it will scan that directory for deleted entries (both files and subdirectories) and display them if found:
+It is possible to completely restore a deleted directory assuming the parent directory exists. To do this, pass the name of the parent directory to slider and it will scan that directory for deleted entries (both files and subdirectories) and display them if found:
 
        # slider /usr
 
 ![scan directory](http://leaf.dragonflybsd.org/~marino/slider-img/scan-dir.01.png "Directory scanned for deleted entries")
 
-Directories are shown in cyan and prefixed with @@0x and a 16-digit hex number.  Files are shown in light gray with no prefix.
+Directories are shown in cyan and prefixed with @@0x and a 16-digit hex number. Files are shown in light gray with no prefix.
 
 To restore the last known directory, use the arrow keys to highlight it and either press "F1" or the "Enter" key.
 
 ![deleted directory information](http://leaf.dragonflybsd.org/~marino/slider-img/scan-dir.02.png "Deleted directory information")
 
-You will be shown an informational screen showing that you selected a deleted directory and showing its time stamp.  That time should match when the directory was deleted.  At this point you can choose to view the contents, restore the directory, or exit.  
+You will be shown an informational screen showing that you selected a deleted directory and showing its time stamp. That time should match when the directory was deleted. At this point you can choose to view the contents, restore the directory, or exit.  
 
 ## View the contents of a deleted directory (static listing only)
 
@@ -139,11 +139,11 @@ Let's see what the contents look like by pressing "F1" key:
 
 ![deleted directory contents](http://leaf.dragonflybsd.org/~marino/slider-img/scan-dir.03.png "Deleted directory contents")
 
-The directory is can be browsed in pages.  It is not possible to browse the files or subdirectories, it is just a static view.  Press "F4" key to return to the informational screen.
+The directory can be browsed in pages. It is not possible to browse the files or subdirectories, it is just a static view. Press "F4" key to return to the informational screen.
 
 ## Restore the complete directory to the original location
 
-If a restoration to the original location is desired, just select the "F2" option.  After passing a confirmation screen, the entire directory will be restored to where it was before.
+If a restoration to the original location is desired, just select the "F2" option. After passing a confirmation screen, the entire directory will be restored to where it was before.
 
 ## Restore the complete directory to the default location
 
@@ -152,11 +152,11 @@ the result of selecting the "F3" option and confirming the restoration.
 
 ## Restore the complete directory to a specified location.
 
-Let's say we want to restore this directory to my home directory.  I'd execute slide something like this:
+Let's say we want to restore this directory to my home directory. I'd execute slide something like this:
 
        # slider /usr /home/marino/old-ports.backup
 
-Then I would select the "ports.old" directory and press the "F3" button.  Now the confirmation screen looks like this:
+Then I would select the "ports.old" directory and press the "F3" button. Now the confirmation screen looks like this:
 
 ![restore location confirmation](http://leaf.dragonflybsd.org/~marino/slider-img/scan-dir.04.png "Confirmation on specified restoration location")
 
@@ -164,7 +164,8 @@ At this point, choose "F1" to complete the restoration or "F4" to return to the
 
 # Scan directory to restore a deleted file
 
-If you already know the name of the file you want to restore, exactly, you can just type it in.  However, if you don't know the name of the file, or you aren't sure how it's spelled, or you just plain forgot what's in the directory, just scan the parent directory and see:
+If you already know the name of the file you want to restore, exactly, you can just type it in.
+However, if you don't know the name of the file, or you aren't sure how it's spelled, or you just plain forgot what's in the directory, just scan the parent directory and see:
 
        # slider /usr/ports/lang
 
@@ -172,13 +173,13 @@ If you already know the name of the file you want to restore, exactly, you can j
 
 Okay, so this directory has both directories and a file in it.
 
-## view the contents of a deleted file from directory scan
+## View the contents of a deleted file from directory scan
 
-It's easy to see the contents if the deleted file was a text file.  Just press "F1" or "Enter" to select the file ...
+It's easy to see the contents if the deleted file was a text file. Just press "F1" or "Enter" to select the file ...
 
 ![deleted file information](http://leaf.dragonflybsd.org/~marino/slider-img/scan-dir.06.png "Deleted file information")
 
-... and you will see that the selection is a file, when it was deleted, and if it is viewable.  If it's a binary file, all you can do is exit or restore it.  However, if it's a text file, you can view it!
+... and you will see that the selection is a file, when it was deleted, and if it is viewable. If it's a binary file, all you can do is exit or restore it. However, if it's a text file, you can view it!
 
 ![view deleted file](http://leaf.dragonflybsd.org/~marino/slider-img/scan-dir.07.png "Example of viewing deleted file from directory scan")
 
@@ -194,7 +195,7 @@ Assuming only one argument was passed to Slider, just select "F3" and confirm th
 
 ## Restore the file to a specified location
 
-Invoke slider with two arguments, the first being the path of the parent directory and the second being the path to restore the file to.  Then just select the file via the list, press "F3" key, and confirm with "F1" key.
+Invoke slider with two arguments, the first being the path of the parent directory and the second being the path to restore the file to. Then just select the file via the list, press "F3" key, and confirm with "F1" key.
 
 # Undelete a file in an existing directory (filename is known)
 
@@ -208,9 +209,9 @@ If Slider thinks it can restore that file, you'd see a screen like this:
 
 ![found deleted file](http://leaf.dragonflybsd.org/~marino/slider-img/deleted.01.png "Slider confirms there is history of a file by that name")
 
-As before, there is only one version considered, the last known one.  You can either recover it or leave.  The easiest thing to do is just press the "F2" to restore the file to its former location:
+As before, there is only one version considered, the last known one. You can either recover it or leave. The easiest thing to do is just press the "F2" to restore the file to its former location:
 
-In the case of selecting "F2" (save), Slider won't even ask you to confirm, it will just do it!  In the case of selecting "F3" you will be presented with a confirmation that changes depending if a target path was specified or not.
+In the case of selecting "F2" (save), Slider won't even ask you to confirm, it will just do it! In the case of selecting "F3" you will be presented with a confirmation that changes depending on if a target path was specified or not.
 
 ![undeleted file](http://leaf.dragonflybsd.org/~marino/slider-img/deleted.02.png "Slider undeletes deleted file without confirmation")
 
@@ -223,6 +224,6 @@ It worked!
 
 The best place to report issues, bugs or provide feedback about slider is https://github.com/jrmarino/Slider/issues
 
-Other places are possible such as DragonFly mailing list, DPorts issues, or DragonFly bug tracker, but it is less effect to place reports there.
+Other places are possible such as DragonFly mailing list, DPorts issues, or DragonFly bug tracker, but it is less effective to place reports there.
 
 Enjoy Slider!