Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
YUCK(1)				 User Commands			       YUCK(1)

NAME
       yuck - Generate command line option parsers for umbrella	commands.

SYNOPSIS
       yuck [OPTION]...	COMMAND	[ARG]...

DESCRIPTION
       Generate	command	line option parsers for	umbrella commands.

       COMMAND may be one of:

       gen    Generate a parser	from definitions in FILE, or stdin if omitted.

       genman Generate	a man page from	definitions in FILE, or	stdin if omit-
	      ted.

       gendsl Generate the intermediary	description of definitions from	 FILE,
	      or stdin if omitted.

       scmver Guess version number for SCM controlled PATH.  If	PATH is	a file
	      run  a  transformation.	If PATH	is a directory just output the
	      version number.

	      Transformations	are   done   through   the    m4    processor:
	      YUCK_SCMVER_VTAG	      will    expand	to   the   tag	 name.
	      YUCK_SCMVER_SCM	   will	expand to the name of  the  SCM	 used.
	      YUCK_SCMVER_DIST	    will  expand  to the distance, that	is the
	      number of
				   commits     since	 the	 last	  tag.
	      YUCK_SCMVER_RVSN	    will  expand to the	current	commit number.
	      YUCK_SCMVER_FLAG_DIRTY  is set for changes in  the  source  tree
	      that have
				   not yet been	committed.

	      Definitions in the template yuck-scmver.m4 are prepended,	and by
	      default  this defines the	YUCK_SCMVER_VERSION macro that expands
	      to the full version number.

       config Output config values for yuck.

       Recognized OPTIONs:

       -h, --help
	      display this help	and exit

       -V, --version
	      output version information and exit

       -k, --keep
	      Keep intermediary	files.

       -o, --output=FILE
	      Output goes into FILE instead of stdout.

COMMANDS
       yuck gen	[OPTION]...  [FILE]...

       OPTIONs specific	to the gen command:

       -H, --header=FILE
	      Also generate a header file.

       --no-auto-flags
	      Do not add auto flags (--help, --version).

       --no-auto-help
	      Do not add auto --help flag

       --no-auto-version
	      Do not add auto --version	flag

       --no-auto-actions
	      Do not automatically handle auto flags.

       --version=VERSION
	      Hardwire version number.

       --custom=FILE
	      Include custom macros from FILE.

       -p, --preserve
	      Preserve indentation and newlines.

       yuck genman [OPTION]...	[FILE]...

       OPTIONs specific	to the genman command:

       --version-string=STRING
	      Hardwire version number as STRING.

       --version-file=FILE
	      Hardwire version number from FILE.

       --package=STRING
	      Use package STRING instead of umbrella.

       -i, --include=FILE...
	      Include sections from FILE

       --info-page[=NAME]
	      Include reference	to Texinfo manual.

       yuck gendsl [OPTION]...	[FILE]...

       OPTIONs specific	to the gendsl command:

       --no-auto-flags
	      Do not add auto flags (--help, --version).

       --no-auto-help
	      Do not add auto --help flag

       --no-auto-version
	      Do not add auto --version	flag

       --no-auto-actions
	      Do not automatically handle auto flags.

       --version=VERSION
	      Hardwire version number.

       -p, --preserve
	      Preserve indentation and newlines.

       yuck scmver [OPTION]...	[PATH]

       OPTIONs specific	to the scmver command:

       -v, --verbose
	      Print additional information on stderr.

       --reference=FILE
	      Store version reference in FILE and don't	touch the output  file
	      if nothing has changed.

       -f, --force
	      Force  operation	even if	the current scm	version	coincides with
	      the reference version.

       -n, --use-reference
	      Use version number provided in the reference file	instead	of de-
	      termining	it.

       --ignore-noscm
	      Don't treat no scm as error.

       yuck config [OPTION]...

       OPTIONs specific	to the config command:

       --m4   Print m4 value used during yuck build.

AUTHOR
       Written by Sebastian Freundt <freundt@fresse.org>

REPORTING BUGS
       Report bugs to: https://github.com/hroptatyr/yuck/issues

yuck 0.2.6.GIT			 November 2025			       YUCK(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=yuck&sektion=1&manpath=FreeBSD+Ports+15.0>

home | help