Merge pull request #4123 from AllskyTeam/3823-allsky.sh---help-doesn'…

…t-work

3823 "allsky.sh --help" doesn't work

allsky.sh

@@ -1,14 +1,10 @@
 #!/bin/bash
 
-# Make it easy to find the beginning of this run in the log file.
-echo "     ***** Starting AllSky *****"
-
 [[ -z ${ALLSKY_HOME} ]] && export ALLSKY_HOME="$( realpath "$( dirname "${BASH_ARGV0}" )" )"
 ME="$( basename "${BASH_ARGV0}" )"
 
 # NOT_STARTED_MSG, STOPPED_MSG, ERROR_MSG_PREFIX, and ZWO_VENDOR are globals
 
-
 #shellcheck source-path=.
 source "${ALLSKY_HOME}/variables.sh"					|| exit "${EXIT_ERROR_STOP}"
 #shellcheck source-path=scripts
@@ -28,6 +24,65 @@ if [[ ! -d ${ALLSKY_CONFIG} ]]; then
 	doExit "${EXIT_ERROR_STOP}" "no-image" "" ""
 fi
 
+####
+usage_and_exit()
+{
+	local RET C MSG
+
+	RET=${1}
+	if [[ ${RET} -eq 0 ]]; then
+		C="${YELLOW}"
+	else
+		C="${RED}"
+	fi
+	{
+		echo -en "\n${C}"
+		echo -n  "Usage: ${ME} [--help] [--preview]"
+		echo -e  "${NC}"
+		echo
+		echo "'--help' displays this message and the help message from the capture program, then exits."
+		echo
+		echo "'--preview' displays images on your screen as they are taken."
+		echo
+	} >&2
+	[[ ${RET} -ne 0 ]] && exit "${RET}"
+}
+
+CAPTURE="capture_${CAMERA_TYPE}"
+
+##### Check arguments
+OK="true"
+HELP="false"
+PREVIEW="false"
+while [[ $# -gt 0 ]]; do
+	ARG="${1}"
+	case "${ARG,,}" in
+		--help)
+			HELP="true"
+			;;
+		--preview)
+			PREVIEW="true"
+			;;
+		-*)
+			echo -e "${RED}Unknown argument: '${ARG}'${NC}." >&2
+			OK="false"
+			;;
+		*)
+			break;		# end of arguments
+			;;
+	esac
+	shift
+done
+[[ ${OK} == "false" ]] && usage_and_exit 1
+if [[ ${HELP} == "true" ]]; then
+	usage_and_exit 0
+	"${ALLSKY_BIN}/${CAPTURE}" --help
+	exit 0
+fi
+
+# Make it easy to find the beginning of this run in the log file.
+echo "     ***** Starting AllSky *****"
+
 # Make sure ${CAMERA_TYPE} is valid; if not, exit with a message.
 verify_CAMERA_TYPE "${CAMERA_TYPE}"
 
@@ -260,29 +315,23 @@ if [[ ${USE_NOTIFICATION_IMAGES} == "true" ]]; then
 	"${ALLSKY_SCRIPTS}/copy_notification_image.sh" --expires 0 "StartingUp" 2>&1 &
 fi
 
-: > "${ARGS_FILE}"
-
 # Only pass settings that are used by the capture program.
 if ! ARGS="$( "${ALLSKY_SCRIPTS}/convertJSON.php" --capture-only )" ; then
 	echo "${ME}: ERROR: convertJSON.php returned: ${ARGS}"
 	set_allsky_status "${ALLSKY_STATUS_ERROR}"
 	exit "${EXIT_ERROR_STOP}"
 fi
+
 # We must pass "-config ${ARGS_FILE}" on the command line and
 # other settings needed at the start of the capture program.
-echo "${ARGS}" |
-	grep -E -i -v "^config=|^debuglevel=^cmd=|^cameramodel|^cameranumber|^locale=" >> "${ARGS_FILE}"
-
-# When using a desktop environment a preview of the capture can be displayed.
-# The preview mode does not work if we are started as a service or
-# if the debian distribution has no desktop environment.
 {
-	[[ $1 == "preview" ]] && echo "preview=true"
+	echo "${ARGS}" |
+		grep -E -i -v "^config=|^debuglevel=^cmd=|^cameramodel|^cameranumber|^locale="
 
 	echo "version=${ALLSKY_VERSION}"
 	echo "save_dir=${CAPTURE_SAVE_DIR}"
-
-} >> "${ARGS_FILE}"
+	[[ ${PREVIEW} == "true" ]] && echo "preview=true"
+} > "${ARGS_FILE}"
 
 # If the user wants images uploaded only every n times, save that number to a file.
 if [[ ${IMG_UPLOAD_FREQUENCY} -ne 1 ]]; then
@@ -293,8 +342,6 @@ else
 	rm -f "${FREQUENCY_FILE}"
 fi
 
-CAPTURE="capture_${CAMERA_TYPE}"
-
 # Clear up any flow timings
 activate_python_venv
 python3 "${ALLSKY_SCRIPTS}/flow-runner.py" --cleartimings

html/documentation/changeLog.html

@@ -60,6 +60,8 @@ <h4>Enhancements / Changes</h4>
 								will work are highlighted like
 								<span class="cm-string highlight">XX_NEED_TO_UPDATE_XX</span>.
 						</ul>
+					<li>Displaying image previews is now done via <code>allsky.sh --preview</code>.
+						It was previously <code>allsky.sh preview</code>.
 				</ul>
 				<h4>Settings</h4>
 				<ul>
@@ -68,7 +70,8 @@ <h4>Settings</h4>
 				</ul>
 				<h4>Bug Fixes</h4>
 				<ul>
-					<li>
+					<li><code>allsky.sh --help</code> now works and displays all the
+						options to the capture programs.
 				</ul>
 				<hr class="separator"><!-- =========================================== -->
 			</details>

html/documentation/installations/Allsky.html

@@ -244,10 +244,10 @@ <h2>Starting and stopping Allsky</h2>
 </p>
 <p>
 If you are using a desktop environment (Pixel, Mate, LXDE, etc.) or using remote desktop or VNC,
-you can add the <code>preview</code> argument to show the images the program is
+you can add the <code>--preview</code> argument to show the images the program is
 currently saving in a separate window:
 <pre>
-./allsky.sh preview
+./allsky.sh --preview
 </pre>
 </p>
 </details>