Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

added more verbose statement for psd and updated manpage

  • Loading branch information...
commit 2ce5d63cccf33def505fc4f1a98c300d0727bc77 1 parent 9af3b88
graysky authored
13 CHANGELOG
View
@@ -1,3 +1,16 @@
+v3.5
+24-May-2012
+Added a little more verbose message when wishing to call psd to sync manually.
+Updated manpage with systemd info.
+
+v3.4
+11-May-2012
+Corrected small typo which caused a problem with google-chrome-dev.
+
+v3.3
+10-May-2012
+Merged xduugu's commit which improves reliability with systemd and also added a few trivial config checks.
+
v3.2
02-Apr-2012
Corrected typeo for opera-next. Thanks to FarStar07.
21 README-for_other_distros
View
@@ -4,6 +4,10 @@ NAME
SYNOPSIS
rc.d [options] psd
+ or
+
+ systemctl [options] psd.service
+
DESCRIPTION
Profile-sync-daemon (psd) is a tiny shell script designed to manage your browser's profile in tmpfs and to periodically sync it back to your 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 completely transparent user experience.
@@ -21,26 +25,27 @@ SETUP
Example:
USERS="bar foo"
- Optionally uncomment and define which browers are to be managed in the BROWSERS array. Note that the default is all browsers unless otherwise defined.
+ Optionally uncomment and define which browsers are to be managed in the BROWSERS array. Note that the default is all browsers unless otherwise defined.
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.
-USAGE
+GENERAL USAGE
+ 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. Users can call the daemon to start, stop, or sync like any standard Arch daemon.
+
+ For more, see: https://wiki.archlinux.org/index.php/Profile-sync-daemon
+
+USAGE FOR SYSV USERS
Do not call /usr/bin/profile-sync-daemon directly. Instead use the distro provided /usr/bin/rc.d to interact with psd via the daemon script.
start Turn on psd. Make symlinks and sync the profile(s) from disc to tmpfs.
stop Turn off psd. Sync the profiles(s) from tmpfs back to disc and remove the symlinks.
sync Sync data between locations. The profile(s) in tmpfs are sync'ed back to the disc and the symlinks are left in place.
-
- Note that as of version 2.9, a template for systemd is provided for profile-sync-daemon.
-
- 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. Users can call the daemon to start, stop, or sync like any standard Arch daemon.
It is highly recommended to start/stop the daemon at boot/shutdown. This is accomplished by adding psd to the DAEMONS array in /etc/rc.conf like so:
-
DAEMONS=(... @psd ...)
- For more, see: https://wiki.archlinux.org/index.php/Profile-sync-daemon
+USAGE FOR SYSTEMD USERS
+ For users of systemd, /usr/lib/systemd/system/psd.service is provided and should be used to manage psd.
SUPPORTED BROWSERS AND CAVEATS
Currently, the following browsers are auto-detected and managed: Chromium, Firefox, Google-chrome, Midori, and Opera, and Opera-Next.
7 profile-sync-daemon
View
@@ -141,6 +141,11 @@ case "$1" in
# make sure the daemon is running
[[ -f $DAEMON_FILE ]] && sync && unsync
;;
- *) ;;
+ *)
+ echo -en "\E[31musage: $0 {sync}"
+ tput sgr0 # reset colors to normal
+ echo
+ echo "sync) force a manual sync"
+ ;;
esac
exit 0
25 psd.manpage
View
@@ -1,5 +1,5 @@
.\" Text automatically generated by txt2man
-.TH profile-sync-daemon "8" "April 2012" "profile-sync-daemon v3.1"
+.TH profile-sync-daemon "8"
.SH NAME
\fBprofile-sync-daemon \fP- Symlinks and syncs browser profile dirs to RAM thus reducing HDD/SDD calls and speeding-up browsers.
\fB
@@ -8,6 +8,10 @@
.fam C
rc.d [\fIoptions\fP] \fIpsd\fP
+ \fBor\fP
+
+ \fBsystemctl\fP [\fIoptions\fP] psd.service
+
.fam T
.fi
.fam T
@@ -21,7 +25,7 @@ Reduced wear to physical discs
.IP 2. 4
Speed
.PP
-Since the \fBprofile\fP(s), browser cache, etc. are relocated into tmpfs, 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. 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.
+Since the \fBprofile\fP(s), browser cache, etc. are relocated into tmpfs, 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. 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.
.SH SETUP
All settings are defined in /etc/psd.conf which is included in the package.
.PP
@@ -30,10 +34,14 @@ At a minimum, define which \fBuser\fP(s) will have their profiles managed by \fI
Example:
USERS="bar foo"
.PP
-Optionally uncomment and define which browers are to be managed in the BROWSERS array. Note that the default is all browsers unless otherwise defined.
+Optionally uncomment and define which browsers are to be managed in the BROWSERS array. Note that the default is all browsers unless otherwise defined.
.PP
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 USAGE
+.SH GENERAL USAGE
+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. Users can call the daemon to start, stop, \fBor\fP sync like any standard Arch daemon.
+.PP
+For more, see: https://wiki.archlinux.org/index.php/Profile-sync-daemon
+.SH USAGE FOR SYSV USERS
Do not call /usr/bin/profile-sync-daemon directly. Instead use the distro provided /usr/bin/rc.d to interact with \fIpsd\fP via the daemon script.
.TP
.B
@@ -48,15 +56,10 @@ Turn off \fIpsd\fP. Sync the \fBprofiles\fP(s) from tmpfs back to disc and remov
sync
Sync data between locations. The \fBprofile\fP(s) in tmpfs are sync'ed back to the disc and the symlinks are left in place.
.PP
-Note that as of version 2.9, a template for systemd is provided for profile-sync-daemon.
-.PP
-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, \fIpsd\fP will sync back a final time when it is called to stop. Users can call the daemon to start, stop, or sync like any standard Arch daemon.
-.PP
It is highly recommended to start/stop the daemon at boot/shutdown. This is accomplished by adding \fIpsd\fP to the DAEMONS array in /etc/rc.conf like so:
-.PP
\fBDAEMONS=\fP(\.\.\. @\fIpsd\fP \.\.\.)
-.PP
-For more, see: https://wiki.archlinux.org/index.php/Profile-sync-daemon
+.SH USAGE FOR SYSTEMD USERS
+For users of systemd, /usr/lib/systemd/system/psd.service is provided and should be used to manage \fIpsd\fP.
.SH SUPPORTED BROWSERS AND CAVEATS
Currently, the following browsers are auto-detected and managed: Chromium, Firefox, Google-chrome, Midori, and Opera, and Opera-Next.
.PP
Please sign in to comment.
Something went wrong with that request. Please try again.