streamline man page

Makefile

@@ -1,4 +1,4 @@
-VERSION = 6.37
+VERSION = 6.38
 PN = profile-sync-daemon
 
 PREFIX ?= /usr

doc/psd.1

@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH profile-sync-daemon 8 "25 April 2020" "" ""
+.TH profile-sync-daemon 1 "26 April 2020" "" ""
 .SH NAME
 \fBprofile-sync-daemon \fP- Symlinks and syncs browser profiles to RAM (tmpfs) thus reducing HDD/SSD calls and speeding up browsers.
 \fB
@@ -188,7 +188,7 @@ A proper work around for firefox is to simply edit ~/.mozilla/firefox/profiles.i
 .fi
 Other solutions may exist for other browsers but documenting them all here is out of scope.
 .SH SUPPORTED DISTROS
-Since psd is just a bash script with a systemd service, it should run on any flavor of Linux running systemd. Several distros provide an official package or user-maintained option to install psd. One can also build psd from source. See the official website for available packages and installation instructions.
+Since psd is just a bash script with a systemd service, it should run on any flavor of Linux running systemd. Several distros provide an official package or user-maintained option to install psd. One can also build psd from source. See the official website for available packages, dependencies, and installation instructions
 .SH FAQ
 Q1: What is overlayfs mode?
 .PP
@@ -198,9 +198,9 @@ See the example in the PREVIEW MODE section above which shows a system using ove
 .PP
 Q2: How do I enable overlayfs mode?
 .PP
-A2: First, be sure psd is not active or else any changes to the config file will be ignored until it is restarted. Overlayfs mode is enabled with the USE_OVERLAYFS= variable which should be set to "yes" in the config file. Psd will automatically detect the overlayfs version available to the kernel if it is configured to use one of them. It is recommended to run psd in preview mode to verify that the system can in fact use overlayfs (note that Debian 8 currently does not support an overlayfs capable kernel version).
+A2: First, be sure psd is not active or else any changes to the config file will be ignored until it is restarted. Overlayfs mode is enabled with the USE_OVERLAYFS= variable which should be set to "yes" in the config file. Psd will automatically detect the overlayfs version available to the kernel if it is configured to use one of them. It is recommended to run psd in preview mode to verify that the system can in fact use overlayfs.
 .PP
-Since version 6.05 of psd, users wanting to use this mode MUST have sudo rights without password prompt to /usr/bin/psd-overlay-helper or global sudo rights without password prompt. If the user does not have global rights, add the following line to /etc/sudoers after any other lines defining sudo access. It is recommended to use /usr/bin/visudo as root to set this up:
+Users wanting to use overlayfs mode MUST have sudo rights without password prompt to /usr/bin/psd-overlay-helper or global sudo rights without password prompt. If the user does not have global rights, add the following line to /etc/sudoers after any other lines defining sudo access. It is recommended to use /usr/bin/visudo as root to set this up:
 .PP
 .nf
 .fam C
@@ -214,11 +214,11 @@ A3: The way overlayfs works is to mount a read-only base copy (so-called lower d
 .PP
 Q4: I need more memory to accommodate my profile/profiles in /run/user/xxxx. How can I allocate more?
 .PP
-A4: The standard way of controlling the size of /run/user is the RuntimeDirectorySize directive in logind.conf (see the man page for logind.conf for more). By default, 10% of physical memory is used but one can increase it safely. Remember that tmpfs only consumes what is actually used; the number specified here is just a maximum allowed.
+A4: The standard way of controlling the size of /run/user/ is the RuntimeDirectorySize directive in logind.conf (see the man page for logind.conf for more). By default, 10% of physical memory is used but one can increase it safely. Remember that tmpfs only consumes what is actually used; the number specified here is just a maximum allowed.
 .PP
 Q5: My system crashed for some reason and psd didn't sync back. What do I do?
 .PP
-A5: The "last good" backup of the browser profile/profiles should be happily on the filesystem. Upon restarting psd (on a reboot for example), a check is performed to see if the symlink to the tmpfs copy of the profile is invalid. If it is invalid, psd will snapshot the "last good" backup before it rotates it back into place. This is more for a sanity check that psd did no harm and that any data loss was a function of something else.
+A5: The "last good" backup of the browser profile/profiles should be the filesystem. Upon restarting psd (on a reboot for example), a check is performed to see if the symlink to the tmpfs copy of the profile is invalid. If it is invalid, psd will snapshot the "last good" backup before it rotates it back into place. This is more for a sanity check that psd did no harm and that any data loss was a function of something else.
 .PP
 Q6: Where can I find this snapshot?
 .PP
@@ -238,9 +238,9 @@ Copy the snapshot directory to the name that browser expects.
 Example using chromium:
 .IP 1. 4
 systemctl \fB--user\fP stop psd.service
-.IP 3. 4
-mv ~/.config/chromium ~/.config/chromium-bad
 .IP 2. 4
+mv ~/.config/chromium ~/.config/chromium-bad
+.IP 3. 4
 cp \fB-a\fP ~/.config/chromium-backup-crashrecovery-20130912_153310 ~/.config/chromium
 .RE
 .PP
@@ -250,9 +250,9 @@ Q8: Can psd delete the snapshots automatically?
 .PP
 A8: Yes, run psd with the "clean" switch to delete snapshots.
 .SH CONTRIBUTE
-Users wishing to contribute to this project, should fork it and send a pull request. Source is freely available on the project page linked below.
+Users wishing to contribute to this project, should fork it and send a pull request. Source is freely available on github.
 .SH BUGS
-Discovered a bug? Please open an issue on the project page linked below.
+Discovered a bug? Please open an issue.
 .RS
 .IP \(bu 3
 Several cases of data loss have been reported when using eCryptFS and psd, therefore until this issue is flushed out, users of eCryptFS are encouraged not to use psd unless willing to help troubleshoot suspected browser corruption. See: https://github.com/graysky2/profile-sync-daemon/issues/158