Skip to content

Commit

Permalink
reworded manpage and documented the resync option
Browse files Browse the repository at this point in the history
  • Loading branch information
graysky2 committed Mar 26, 2013
1 parent b9ec28e commit 07fc46a
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 13 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
v5.32
25-Mar-2013
Reworded manpage and documented the resync option.

v5.31
17-Mar-2013
Support for new profile location with qupzilla.
Expand Down
2 changes: 1 addition & 1 deletion Makefile.archlinux
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
VERSION = 5.31
VERSION = 5.32
PN = profile-sync-daemon

PREFIX ?= /usr
Expand Down
2 changes: 1 addition & 1 deletion Makefile.exherbo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
VERSION = 5.31
VERSION = 5.32
PN = profile-sync-daemon

PREFIX ?= /usr
Expand Down
2 changes: 1 addition & 1 deletion Makefile.fedora18
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
VERSION = 5.31
VERSION = 5.32
PN = profile-sync-daemon

PREFIX ?= /usr
Expand Down
2 changes: 1 addition & 1 deletion Makefile.gentoo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
VERSION = 5.31
VERSION = 5.32
PN = profile-sync-daemon

PREFIX ?= /usr
Expand Down
2 changes: 1 addition & 1 deletion Makefile.ubuntu
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
VERSION = 5.31
VERSION = 5.32
PN = profile-sync-daemon

DESTDIR =
Expand Down
3 changes: 2 additions & 1 deletion common/profile-sync-daemon
Original file line number Diff line number Diff line change
Expand Up @@ -386,14 +386,15 @@ case "$1" in
echo
echo -e " ${BLD}$0 ${NRM}${GRN}[option]${NRM}"
echo -e " ${BLD} ${NRM}${GRN}preview${NRM}${BLD} Parse config file (${NRM}${BLU}${PSDCONF}${NRM}${BLD}) to see which profiles will be managed."${NRM}
echo -e " ${BLD} ${NRM}${GRN}resync${NRM}${BLD} Synchronize the tmpfs and media bound copy. Must be run as root user."${NRM}
echo -e " ${BLD} ${NRM}${RED}sync${NRM}${BLD} Force a manual sync. Must be run as root user and NOT recommended."${NRM}
echo -e " ${BLD} ${NRM}${RED}unsync${NRM}${BLD} Force a manual unsync. Must be run as root user and NOT recommended."${NRM}
echo
echo -e " ${BLD}It is ${RED}HIGHLY DISCOURAGED${NRM}${BLD} to directly call $0 to sync or to unsync."${NRM}
if [[ -f /usr/lib/systemd/system/psd.service ]]; then
echo -e " ${BLD}Instead, use systemd to start/stop profile-sync-daemon."${NRM}
echo
echo -e " ${BLD}systemctl ${NRM}${GRN}[option]${NRM}${BLD} psd.service"${NRM}
echo -e " ${BLD}systemctl ${NRM}${GRN}[option]${NRM}${BLD} psd psd-resync"${NRM}
echo -e " ${BLD} ${NRM}${GRN}start${NRM}${BLD} Turn on daemon; make symlinks and actively manage targets in tmpfs."${NRM}
echo -e " ${BLD} ${NRM}${GRN}stop${NRM}${BLD} Turn off daemon; remove symlinks and rotate tmpfs data back to disc."${NRM}
echo -e " ${BLD} ${NRM}${GRN}enable${NRM}${BLD} Autostart daemon when system comes up."${NRM}
Expand Down
12 changes: 5 additions & 7 deletions doc/psd.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" Text automatically generated by txt2man
.TH profile-sync-daemon 1 "17 March 2013" "" ""
.TH profile-sync-daemon 1 "25 March 2013" "" ""
.SH NAME
\fBprofile-sync-daemon \fP- Symlinks and syncs browser profiles to RAM (tmpfs) thus reducing HDD/SDD calls and speeding-up browsers.
\fB
Expand Down Expand Up @@ -32,7 +32,7 @@ Optionally define the location of your distro's tmpfs. Do this in the VOLATILE v
Optionally define the location of your distro's /run. Do this in the DAEMON_FILE variable.
.SH RUNNING PSD
.SS PREVIEW MODE
The preview (parse) option can be called to show users exactly what psd will do based on the entries in /etc/psd.conf. Call it like so:
The preview (parse) option can be called to show users exactly what psd will do based on the entries in /etc/psd.conf.
.PP
.nf
.fam C
Expand All @@ -42,10 +42,8 @@ The preview (parse) option can be called to show users exactly what psd will do

.fam T
.fi
.SS START AND STOP THE DAEMON
Do NOT call /usr/bin/profile-sync-daemon to sync or to unsync directly! Instead, use your distro's init system.
.SS SYSTEMD
Both a systemd service file and timer are provided, and should be used to interact with psd. Both should be invoked together! The role of the timer is update the tmpfs copies back to the disk. This occurs once per hour by default. Failure to start the resync timer will result in the profile being sync'ed only on start up and shutdown.
.SS START AND STOP PSD FOR SYSTEMD USERS
Both a systemd service file and timer are provided, and should be used to interact with psd. BOTH SHOULD BE INVOKED TOGETHER. The role of the timer is update the tmpfs copies back to the disk. This occurs once per hour by default. Failure to start the resync timer will result in the profile being sync'ed only on start up and shutdown.
.PP
.nf
.fam C
Expand All @@ -71,7 +69,7 @@ Autostart daemon on boot-up.
.B
disable
Don't autostart daemon on boot-up.
.SS OTHER INITSCRIPTS
.SS START AND STOP PSD FOR USERS OF OTHER INIT SYSTEMS
For distros not using systemd, another init script should be used to manage the daemon. Examples are provided and are known to work with the following distros: Debian, Mint, Gentoo, and Ubuntu. Note that for these distros, the supplied cron script (installed to /etc/cron.hourly) will run the resync option to keep the tmpfs copies sync'ed. Of course, the target system must have cron installed and active for this to happen.
.PP
.nf
Expand Down

0 comments on commit 07fc46a

Please sign in to comment.