Permalink
Browse files

minor update to man page and to README

  • Loading branch information...
1 parent 310e7a5 commit bee19827d2c3f4d64a6029a6d6b4dd5388dd672a @graysky2 committed Feb 6, 2013
Showing with 46 additions and 25 deletions.
  1. +4 −0 CHANGELOG
  2. +17 −8 README-for_other_distros
  3. +1 −0 README.md
  4. +24 −17 psd.manpage
View
@@ -1,3 +1,7 @@
+v5.13
+06-Feb-2013
+Minor update to man page and to README.
+
v5.12
02-Feb-2013
Added dependency checks and debain init script (provided by jcharaoui).
View
@@ -10,19 +10,18 @@ DESCRIPTION
Profile-sync-daemon (psd) is a tiny pseudo-daemon designed to manage your browser profile(s) in tmpfs and to periodically sync back to the physical disc (HDD/SSD). This is accomplished via a symlinking step and an innovative use of rsync to maintain back-up and synchronization between the two. One of the major design goals of psd is a completely transparent user experience.
Running this daemon is beneficial for two reasons:
+
o Reduced wear to physical discs (particularly SSDs)
o Speed
Since the profile(s), browser cache*, etc. are relocated into tmpfs (RAM disk), the corresponding onslaught of I/O associated with using the browser is also redirected from the physical disc to RAM, thus reducing wear to the physical disc and also greatly improving browser speed and responsiveness. For example, the access time of RAM is on the order of nanoseconds while the access time of physical discs is on the order of milliseconds. This is a difference of six orders of magnitude or 1,000,000 times faster.
-*Note that some browsers such as Chromium, Google-chrome, and Midori, actually keeps their cache directories separately from their browser profile directory. It is not within the scope of profile-sync-daemon to modify this behavior; users are encouraged to modify this behavir. For example, refer to the following url for several work-arounds for the Chrome-based browsers: https://wiki.archlinux.org/index.php/Chromium_Tips_and_Tweaks#Cache_in_tmpfs
-
-SETUP
-User managed settings are defined in /etc/psd.conf which is included in the package. At a minimum, define which user(s) will have their profiles managed by psd and note that at least one user must be defined.
-Example:
+*Note that some browsers such as Chromium, Google-chrome, and Midori, actually keeps their cache directories separately from their browser profile directory. It is not within the scope of profile-sync-daemon to modify this behavior; users are encouraged to modify this behavior. For example, refer to the following url for several work-arounds for the Chrome-based browsers: https://wiki.archlinux.org/index.php/Chromium_Tips_and_Tweaks#Cache_in_tmpfs
- USERS="bar foo"
+SETUP
+User managed settings are defined in /etc/psd.conf which is included in the package.
+ o At a minimum, define which user(s) will have their profiles managed by psd and note that at least one user must be defined.
o Optionally uncomment and define which browsers are to be managed in the BROWSERS array. Note that the default is all browsers unless otherwise defined.
o Optionally redefine the location of your distro's tmpfs. Do this in the VOLATILE variable. Note that for Arch Linux, the default value of "/tmp" should work just fine.
@@ -34,7 +33,7 @@ The parse option can be called to show users exactly what psd will do based on t
As you will see in the output and as stated above, if no specific browser or subset of browsers are defined in the BROWSERS array, psd will sync ALL supported profiles that it finds for the given user(s).
GENERAL USAGE
-Do not call /usr/bin/profile-sync-daemon to sync or to unsync directly. Instead use the provided service file. The initial synchronization will occur when the daemon starts. Additionally, cron (if running on your system) will call it to sync or update once per hour. Finally, psd will sync back a final time when it is called to stop.
+Do NOT call /usr/bin/profile-sync-daemon to sync or to unsync directly! Instead, use your distro's init system. The initial synchronization will occur when the daemon starts. Additionally, cron (if running on your system) will call it to sync or update once per hour. Finally, psd will sync back a final time when it is called to stop.
FOR SYSTEMD USERS (OFFICIALLY SUPPORTED METHOD)
The provided daemon file should be used to interact with psd (/usr/lib/systemd/system/psd.service):
@@ -48,7 +47,7 @@ Available options:
disable Remove daemon from the list of autostart daemons.
OTHER INITSCRIPTS
-Other init script may be used to manage the deamon, but they are unsupported by the author.
+Other init scripts may be used to manage the deamon, but they are unsupported by the author.
SUPPORTED BROWSERS
Currently, the following browsers are auto-detected and managed:
@@ -83,6 +82,16 @@ The following is an example of a BAD profile that will not pass the test. You ca
IsRelative=0
Path=/mnt/data/docs/happy/mozilla/firefox/myprofile.abc
+SUPPORTED DISTROS
+At this time, The only officially supported distro package is for Arch Linux and can be downloaded and built from the AUR at the following URL: https://aur.archlinux.org/packages/profile-sync-daemon/
+
+UNSUPPORTED DISTROS
+Psd is a simple bash script and should therefore run on any Linux distro. Below is a list of distros known to package psd, and a link to download their respective packages. As noted above, these are unsupported by the author due to their own, unique init scripts:
+
+ o Chakra Linux via CCR Package: http://chakra-linux.org/ccr/packages.php?ID=3388
+ o Gentoo via Ebuild: http://packages.gentoo.org/package/www-misc/profile-sync-daemon
+ o Ubuntu package: http://link.coming.soon
+
CONTRIBUTE
Should you wish to contribute to this code, please fork and send a pull request. Source is freely available on github: https://github.com/graysky2/profile-sync-daemon
View
@@ -5,6 +5,7 @@ Profile-sync-daemon (psd) is a tiny pseudo-daemon designed to manage your browse
* Arch Linux via AUR Package: https://aur.archlinux.org/packages/profile-sync-daemon
* Chakra Linux via CCR Package: http://chakra-linux.org/ccr/packages.php?ID=3388
* Gentoo via Ebuild: http://packages.gentoo.org/package/www-misc/profile-sync-daemon
+* Ubuntu via user created dev: http://link.coming.soon
If you are interested in packaging psd for your favorite distro, please contact me and I will add the link here.
View
@@ -1,5 +1,5 @@
.\" Text automatically generated by txt2man
-.TH profile-sync-daemon 1 "02 December 2012" "" ""
+.TH profile-sync-daemon 1 "06 February 2013" "" ""
.SH NAME
\fBprofile-sync-daemon \fP- Symlinks and syncs browser profile dirs to RAM thus reducing HDD/SDD calls and speeding-up browsers.
\fB
@@ -26,21 +26,17 @@ Speed
.RE
.PP
Since the \fBprofile\fP(s), browser cache*, etc. are relocated into tmpfs (RAM disk), the corresponding onslaught of I/O associated with using the browser is also redirected from the physical disc to RAM, thus reducing wear to the physical disc and also greatly improving browser speed and responsiveness. For example, the access time of RAM is on the order of nanoseconds while the access time of physical discs is on the order of milliseconds. This is a difference of six orders of magnitude \fBor\fP 1,000,000 times faster.
-*Note that some browsers such as Chromium, Google-chrome, and Midori, actually keeps their cache directories separately from their browser profile directory. It is not within the scope of profile-sync-daemon to modify this behavior; users are encouraged to modify this behavir. For example, refer to the following url for several work-arounds for the Chrome-based browsers: https://wiki.archlinux.org/index.php/Chromium_Tips_and_Tweaks#Cache_in_tmpfs
-.SH SETUP
-User managed settings are defined in /etc/psd.conf which is included in the package. At a minimum, define which \fBuser\fP(s) will have their profiles managed by \fIpsd\fP and note that at least one user must be defined.
-.PP
-Example:
.PP
-.nf
-.fam C
- USERS="bar foo"
-
- o Optionally uncomment and define which browsers are to be managed in the BROWSERS array. Note that the default is all browsers unless otherwise defined.
- o Optionally redefine the location of your distro's tmpfs. Do this in the VOLATILE variable. Note that for Arch Linux, the default value of "/tmp" should work just fine.
-
-.fam T
-.fi
+*Note that some browsers such as Chromium, Google-chrome, and Midori, actually keeps their cache directories separately from their browser profile directory. It is not within the scope of profile-sync-daemon to modify this behavior; users are encouraged to modify this behavior. For example, refer to the following url for several work-arounds for the Chrome-based browsers: https://wiki.archlinux.org/index.php/Chromium_Tips_and_Tweaks#Cache_in_tmpfs
+.SH SETUP
+User managed settings are defined in /etc/psd.conf which is included in the package.
+.RS
+.IP \(bu 3
+At a minimum, define which \fBuser\fP(s) will have their profiles managed by \fIpsd\fP and note that at least one user must be defined.
+.IP \(bu 3
+Optionally uncomment and define which browsers are to be managed in the BROWSERS array. Note that the default is all browsers unless otherwise defined.
+.IP \(bu 3
+Optionally redefine the location of your distro's tmpfs. Do this in the VOLATILE variable. Note that for Arch Linux, the default value of "/tmp" should work just fine.
.SH PARSE MODE
The parse option can be called to show users exactly what \fIpsd\fP will do based on the /etc/psd.conf entered. Call it like so:
.PP
@@ -52,7 +48,7 @@ The parse option can be called to show users exactly what \fIpsd\fP will do base
.fi
As you will see in the output and as stated above, if no specific browser \fBor\fP subset of browsers are defined in the BROWSERS array, \fIpsd\fP will sync ALL supported profiles that it finds for the given \fBuser\fP(s).
.SH GENERAL USAGE
-Do not call /usr/bin/profile-sync-daemon to sync \fBor\fP to unsync directly. Instead use the provided service file. The initial synchronization will occur when the daemon starts. Additionally, cron (if running on your system) will call it to sync \fBor\fP update once per hour. Finally, \fIpsd\fP will sync back a final time when it is called to stop.
+Do NOT call /usr/bin/profile-sync-daemon to sync \fBor\fP to unsync directly! Instead, use your distro's init system. The initial synchronization will occur when the daemon starts. Additionally, cron (if running on your system) will call it to sync \fBor\fP update once per hour. Finally, \fIpsd\fP will sync back a final time when it is called to stop.
.PP
FOR SYSTEMD USERS (OFFICIALLY SUPPORTED METHOD)
The provided daemon file should be used to interact with \fIpsd\fP (/usr/lib/systemd/system/psd.service):
@@ -82,7 +78,7 @@ Autostart daemon when system comes up.
disable
Remove daemon from the list of autostart daemons.
.SH OTHER INITSCRIPTS
-Other init script may be used to manage the deamon, but they are unsupported by the author.
+Other init scripts may be used to manage the deamon, but they are unsupported by the author.
.SH SUPPORTED BROWSERS
Currently, the following browsers are auto-detected and managed:
.RS
@@ -129,6 +125,17 @@ The following is an example of a BAD profile that will not pass the test. You ca
.fam T
.fi
+.SH SUPPORTED DISTROS
+At this time, The only officially supported distro package is for Arch Linux and can be downloaded and built from the AUR at the following URL: https://aur.archlinux.org/packages/profile-sync-daemon/
+.SH UNSUPPORTED DISTROS
+Psd is a simple bash script and should therefore run on any Linux distro. Below is a list of distros known to package \fIpsd\fP, and a link to download their respective packages. As noted above, these are unsupported by the author due to their own, unique init scripts:
+.RS
+.IP \(bu 3
+Chakra Linux via CCR Package: http://chakra-linux.org/ccr/packages.php?ID=3388
+.IP \(bu 3
+Gentoo via Ebuild: http://packages.gentoo.org/package/www-misc/profile-sync-daemon
+.IP \(bu 3
+Ubuntu package: http://link.coming.soon
.SH CONTRIBUTE
Should you wish to contribute to this code, please fork and send a pull request. Source is freely available on github: https://github.com/graysky2/profile-sync-daemon
.SH BUGS

0 comments on commit bee1982

Please sign in to comment.