From c7ff2d99c5669de0a63f59f3b2d2dcc3064b01c3 Mon Sep 17 00:00:00 2001 From: indexzero Date: Thu, 23 Jun 2011 01:57:45 -0400 Subject: [PATCH] [doc] Update the help in the forever CLI and README.md --- README.md | 27 +++++++++++++++------------ bin/forever | 30 +++++++++++++++--------------- 2 files changed, 30 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index e5fe10ce..80d0c29c 100644 --- a/README.md +++ b/README.md @@ -44,18 +44,21 @@ You can use forever to run any kind of script continuously (whether it is writte cleanlogs [CAREFUL] Deletes all historical forever log files options: - -m MAX Only run the specified script MAX times - -l LOGFILE Logs the forever output to LOGFILE - -o OUTFILE Logs stdout from child script to OUTFILE - -e ERRFILE Logs stderr from child script to ERRFILE - -d SOURCEDIR The source directory for which SCRIPT is relative to - -p PATH Base path for all forever related files (pid files, etc.) - -c COMMAND COMMAND to execute (defaults to node) - --pidfile The pid file - -a, --append Append logs - -v, --verbose Turns on the verbose messages from Forever - -s, --silent Run the child script silencing stdout and stderr - -h, --help You're staring at it + -m MAX Only run the specified script MAX times + -l LOGFILE Logs the forever output to LOGFILE + -o OUTFILE Logs stdout from child script to OUTFILE + -e ERRFILE Logs stderr from child script to ERRFILE + -p PATH Base path for all forever related files (pid files, etc.) + -c COMMAND COMMAND to execute (defaults to node) + -a, --append Append logs + --pidfile The pid file + --sourceDir The source directory for which SCRIPT is relative to + --minUptime Minimum uptime (millis) for a script to not be considered "spinning" + --spinSleepTime Time to wait (millis) between launches of a spinning script. + -d, --debug Forces forever to log debug output + -v, --verbose Turns on the verbose messages from Forever + -s, --silent Run the child script silencing stdout and stderr + -h, --help You're staring at it [Long Running Process] The forever process will continue to run outputting log messages to the console. diff --git a/bin/forever b/bin/forever index 706d968e..bfa98731 100755 --- a/bin/forever +++ b/bin/forever @@ -41,21 +41,21 @@ var help = [ ' cleanlogs [CAREFUL] Deletes all historical forever log files', '', 'options:', - ' -m MAX Only run the specified script MAX times', - ' -l LOGFILE Logs the forever output to LOGFILE', - ' -o OUTFILE Logs stdout from child script to OUTFILE', - ' -e ERRFILE Logs stderr from child script to ERRFILE', - ' -p PATH Base path for all forever related files (pid files, etc.)', - ' -c COMMAND COMMAND to execute (defaults to node)', - ' -a, --append Append logs', - ' --pidfile The pid file', - ' --sourceDir The source directory for which SCRIPT is relative to', - ' --minUptime Minimum uptime (millis) for a script to not be considered "spinning"', - ' --spinSleepTime Time to wait (millis) between launches of a spinning script.', - ' -d, --debug Forces forever to log debug output', - ' -v, --verbose Turns on the verbose messages from Forever', - ' -s, --silent Run the child script silencing stdout and stderr', - ' -h, --help You\'re staring at it', + ' -m MAX Only run the specified script MAX times', + ' -l LOGFILE Logs the forever output to LOGFILE', + ' -o OUTFILE Logs stdout from child script to OUTFILE', + ' -e ERRFILE Logs stderr from child script to ERRFILE', + ' -p PATH Base path for all forever related files (pid files, etc.)', + ' -c COMMAND COMMAND to execute (defaults to node)', + ' -a, --append Append logs', + ' --pidfile The pid file', + ' --sourceDir The source directory for which SCRIPT is relative to', + ' --minUptime Minimum uptime (millis) for a script to not be considered "spinning"', + ' --spinSleepTime Time to wait (millis) between launches of a spinning script.', + ' -d, --debug Forces forever to log debug output', + ' -v, --verbose Turns on the verbose messages from Forever', + ' -s, --silent Run the child script silencing stdout and stderr', + ' -h, --help You\'re staring at it', '', '[Long Running Process]', ' The forever process will continue to run outputting log messages to the console.',