Update --help to reflect all the supported options (#12)

OpenIPC · Oct 4, 2024 · d6b1ae2 · d6b1ae2
1 parent 4579eda
commit d6b1ae2
Showing 1 changed file with 15 additions and 9 deletions.
diff --git a/src/main.cpp b/src/main.cpp
@@ -508,23 +508,29 @@ void printHelp() {
     "    pixelpilot [Arguments]\n"
     "\n"
     "  Arguments:\n"
-    "    -p [Port]         		- Listen port                           (Default: 5600)\n"
+    "    -p <port>              - UDP port for RTP video stream         (Default: 5600)\n"
     "\n"
-    "    --osd          		- Enable OSD\n"
+    "    --mavlink-port <port>  - UDP port for mavlink telemetry        (Default: 14550)\n"
     "\n"
-    "    --osd-elements 		- Customize osd elements   			    (Default: video,wfbng,telem)\n"
+    "    --codec <codec>        - Video codec, should be the same as on VTX  (Default: h265 <h264|h265>)\n"
     "\n"
-    "    --osd-telem-lvl		- Level of details for telemetry in the OSD (Default: 1 [1-2])\n"
+    "    --osd                  - Enable OSD\n"
     "\n"
-    "    --osd-refresh  		- Defines the delay between osd refresh (Default: 1000 ms)\n"
+    "    --osd-elements <els>	- Customize osd elements   			    (Default: video,wfbng,telem)\n"
     "\n"
-    "    --dvr             		- Save the video feed (no osd) to the provided filename\n"
+    "    --osd-telem-lvl <lvl>	- Level of details for telemetry in the OSD (Default: 1 [1-2])\n"
     "\n"
-    "    --dvr-framerate        - Force the dvr framerate fro smoother dvr\n"
+    "    --osd-refresh <rate>   - Defines the delay between osd refresh (Default: 1000 ms)\n"
     "\n"
-    "    --dvr-fmp4            	- Save the video feed as a fragmented mp4\n"
+    "    --dvr <path.mp4>       - Save the video feed (no osd) to the provided filename\n"
     "\n"
-    "    --screen-mode   		- Override default screen mode. ex:1920x1080@120\n"
+    "    --dvr-framerate <rate> - Force the dvr framerate for smoother dvr, ex: 60\n"
+    "\n"
+    "    --dvr-fmp4             - Save the video feed as a fragmented mp4\n"
+    "\n"
+    "    --screen-mode <mode>   - Override default screen mode. <width>x<heigth>@<fps> ex: 1920x1080@120\n"
+    "\n"
+    "    --version              - Show program version\n"
     "\n", PILOT_VERSION_MAJOR, PILOT_VERSION_MINOR
   );
 }