From 721e29655935dbb42d72d156c1c2a367a301aec6 Mon Sep 17 00:00:00 2001 From: Dennis Fink Date: Fri, 22 May 2026 22:52:13 +0200 Subject: docs(devscripts): use runtime defaults in help text Replace hardcoded generate-testfile help defaults with the current variable values so usage output stays accurate when script defaults change. Format long printf argument lists in developer scripts one value per line to make the placeholders easier to review and maintain. --- devscripts/generate-testfile.sh | 35 +++++++++++++++++++++++++---------- 1 file changed, 25 insertions(+), 10 deletions(-) (limited to 'devscripts/generate-testfile.sh') diff --git a/devscripts/generate-testfile.sh b/devscripts/generate-testfile.sh index fab91cd..d1eb57a 100755 --- a/devscripts/generate-testfile.sh +++ b/devscripts/generate-testfile.sh @@ -189,13 +189,13 @@ function print_help() { ${BOLD}${BLUE}Usage:${ALL_OFF} ${BOLD}${MAGENTA}%s${ALL_OFF} ${BOLD}${YELLOW}[OPTION]...${ALL_OFF} ${BOLD}${GREEN}[OUTPUT]${ALL_OFF} ${BOLD}${BLUE}Generation options:${ALL_OFF} - ${BOLD}${YELLOW}-c, --codec${ALL_OFF} ${BOLD}${GREEN}CODEC${ALL_OFF} ffmpeg video codec to use (default: libx264) - ${BOLD}${YELLOW}-r, --resolution${ALL_OFF} ${BOLD}${GREEN}WIDTHxHEIGHT${ALL_OFF} output resolution (default: 1280x720) - ${BOLD}${YELLOW}-l, --length${ALL_OFF} ${BOLD}${GREEN}DURATION${ALL_OFF} test file length, in ffmpeg duration syntax (default: 5) - ${BOLD}${YELLOW}--rate${ALL_OFF} ${BOLD}${GREEN}FPS${ALL_OFF} frame rate for the generated source (default: 30) - ${BOLD}${YELLOW}--source${ALL_OFF} ${BOLD}${GREEN}SOURCE${ALL_OFF} lavfi video source (default: smptebars) - ${BOLD}${YELLOW}--pix-fmt${ALL_OFF} ${BOLD}${GREEN}FORMAT${ALL_OFF} output pixel format (default: yuv420p) - ${BOLD}${YELLOW}--ffmpeg-loglevel${ALL_OFF} ${BOLD}${GREEN}LEVEL${ALL_OFF} ffmpeg log level (default: warning) + ${BOLD}${YELLOW}-c, --codec${ALL_OFF} ${BOLD}${GREEN}CODEC${ALL_OFF} ffmpeg video codec to use (default: ${BOLD}${RED}%s${ALL_OFF}) + ${BOLD}${YELLOW}-r, --resolution${ALL_OFF} ${BOLD}${GREEN}WIDTHxHEIGHT${ALL_OFF} output resolution (default: ${BOLD}${RED}%s${ALL_OFF}) + ${BOLD}${YELLOW}-l, --length${ALL_OFF} ${BOLD}${GREEN}DURATION${ALL_OFF} test file length, in ffmpeg duration syntax (default: ${BOLD}${RED}%d${ALL_OFF}) + ${BOLD}${YELLOW}--rate${ALL_OFF} ${BOLD}${GREEN}FPS${ALL_OFF} frame rate for the generated source (default: ${BOLD}${RED}%d${ALL_OFF}) + ${BOLD}${YELLOW}--source${ALL_OFF} ${BOLD}${GREEN}SOURCE${ALL_OFF} lavfi video source (default: ${BOLD}${RED}%s${ALL_OFF}) + ${BOLD}${YELLOW}--pix-fmt${ALL_OFF} ${BOLD}${GREEN}FORMAT${ALL_OFF} output pixel format (default: ${BOLD}${RED}%s${ALL_OFF}) + ${BOLD}${YELLOW}--ffmpeg-loglevel${ALL_OFF} ${BOLD}${GREEN}LEVEL${ALL_OFF} ffmpeg log level (default: ${BOLD}${RED}%s${ALL_OFF}) ${BOLD}${YELLOW}-o, --output${ALL_OFF} ${BOLD}${GREEN}FILE${ALL_OFF} write to FILE instead of generated testfiles/ name ${BOLD}${YELLOW}-f, --force${ALL_OFF} overwrite an existing output file ${BOLD}${YELLOW}-n, --dry-run${ALL_OFF} show the ffmpeg command without creating a file @@ -218,7 +218,17 @@ ${BOLD}${BLUE}Examples:${ALL_OFF} " \ "$SCRIPTNAME" "$VERSION" "$DESCRIPTION" \ "$SCRIPTNAME" \ - "$SCRIPTNAME" "$SCRIPTNAME" "$SCRIPTNAME" "$SCRIPTNAME" + "$CODEC" \ + "$RESOLUTION" \ + "$LENGTH" \ + "$FRAME_RATE" \ + "$FILTER" \ + "$PIX_FMT" \ + "$FFMPEG_LOGLEVEL" \ + "$SCRIPTNAME" \ + "$SCRIPTNAME" \ + "$SCRIPTNAME" \ + "$SCRIPTNAME" } function print_version() { @@ -256,8 +266,13 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n" \ - "$SCRIPTNAME" "$VERSION" "$DESCRIPTION" "$AUTHOR" "$DATE_OF_CREATION" \ - "$DATE_OF_REVISION" "$LICENSE" + "$SCRIPTNAME" \ + "$VERSION" \ + "$DESCRIPTION" \ + "$AUTHOR" \ + "$DATE_OF_CREATION" \ + "$DATE_OF_REVISION" \ + "$LICENSE" } ############################################################################### -- cgit v1.3.1