Add man page / help text for 'sy daemon'

syncany · Sep 6, 2014 · 453feae · 453feae
1 parent 24d98a2
commit 453feae
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 4 deletions.
diff --git a/gradle/daemon/syncanyd.skel b/gradle/daemon/syncanyd.skel
@@ -168,11 +168,11 @@ case "$1" in
 				daemon_force_stop
 				;; 
 			*) 
-				echo "Usage: sy daemon (start|stop|reload|restart|status|force-stop)"
+				#JAVA_EXEC_REPLACEMENT_MARKER#
 				;;
 		esac
 		;;            
 	*)                       
-        	#JAVA_EXEC_REPLACEMENT_MARKER#
+		#JAVA_EXEC_REPLACEMENT_MARKER#
 		;;
 esac                          
diff --git a/gradle/gradle/application.java.gradle b/gradle/gradle/application.java.gradle
@@ -26,7 +26,7 @@ subprojects {
 
 	processResources {	
 		from(source) {
-			include "**/*.properties", "**/*.xml"
+			include "**/*.properties", "**/*.xml", "**/*.skel"
 			filter{ String line -> line.replaceAll('%applicationRelease%', "${applicationRelease}") }        	            
 			filter{ String line -> line.replaceAll('%applicationVersion%', "${applicationVersion}") }        	            
 			filter{ String line -> line.replaceAll('%applicationVersionFull%', "${applicationVersionFull}") }        	            

diff --git a/syncany-cli/src/main/resources/org/syncany/cli/cmd/help.daemon.skel b/syncany-cli/src/main/resources/org/syncany/cli/cmd/help.daemon.skel
@@ -0,0 +1,39 @@
+NAME
+  sy-daemon - starts and stops the background process (daemon)
+
+SYNOPSIS
+  sy daemon (start|stop|reload|restart|status|force-stop)
+
+DESCRIPTION 
+  This command manages the Syncany background process (aka the daemon). It can
+  start and stop the daemon, display the status and reload the daemon
+  configuration.
+
+  This daemon can be started with `sy daemon start`. Once it is running, all
+  registered folders are monitored for changes and remote changes are
+  automatically applied to the local folder(s). All of these actions happen
+  in the background, without the need for any intervention.
+
+  The daemon is configured using the `daemon.xml` file  at 
+  ~/.config/syncany/daemon.xml.
+
+OPTIONS
+  start
+    Starts the background process (if it is not already running).
+
+  stop
+    Stops the background process (if it is running).
+
+  reload
+    Reloads the daemon configuration without restarting the proces.
+
+  restart
+    Stops, then starts the daemon again. 
+
+  status
+    Displays the status and the process ID (PID) of the daemon.
+
+  force-stop
+    Forces the process to stop. Do not use this unless absolutely necessary!
+
+%RESOURCE:incl/footer.skel%
diff --git a/syncany-cli/src/main/resources/org/syncany/cli/cmd/help.skel b/syncany-cli/src/main/resources/org/syncany/cli/cmd/help.skel
@@ -24,6 +24,7 @@ DESCRIPTION
     restore    Restore the given file paths from the remote repository. 
     genlink    Create a syncany:// link from an existing local folder. 
     plugin     List, install and remove storage backend plugins.
+    daemon     Start and stop the background process (daemon).
 
   Short command descriptions and options can be found below. Detailed 
   explanations can be queried with `sy <command> --help`. 
@@ -62,4 +63,4 @@ REPORTING BUGS
   Please report bugs to the GitHub issues page at
      https://www.github.com/syncany/syncany/issues
 
-%RESOURCE:incl/footer.skel%
+%RESOURCE:incl/footer.skel%