CHICKEN-INSTALL(1)

πŸ’… CHICKEN-INSTALL πŸ’…

okay so bestie, this is a page from the General Commands Manual β€” it's chicken-install(1), and honestly? she's that girl. buckle up πŸŽ€


✨ SYNOPSIS ✨

chicken-install [OPTION ...] [NAME[:VERSION] ...]

🌸 DESCRIPTION 🌸

chicken-install downloads, compiles and installs a prepackaged extension library from sources. literally the whole glow-up pipeline in one command πŸ’–

and listen β€” if no extension name is given on the command line, then any existing egg descriptions in the current directory will be executed in unspecified order. no cap, unspecified. don't come for me about ordering, it's giving chaos-on-purpose 😭

the program accepts the following arguments:

πŸ¦‹ the arguments (yes, all of them, i'm not skipping a single one) πŸ¦‹

  • -h, -help β€” show usage and exit. bye bestie πŸ‘‹
  • -version β€” show version and exit.
  • -v, -verbose β€” print extra information during installation. she's chatty and we love that πŸ—£οΈ
  • -force β€” install without confirmation, even if versions don't match. bold. reckless. iconic πŸ”₯
  • -k, -keep β€” keep temporary files. packrat energy 🐿️
  • -s, -sudo β€” use an external program to elevate privileges for filesystem operations. the program defaults to sudo(8) but can be overridden with the SUDO environment variable. so fancy πŸ’…
  • -r, -retrieve β€” just retrieve the egg, don't install it. (giving -r more than once implies -recursive.) window shopping only πŸ›οΈ
  • -recursive β€” if -retrieve is given, also fetch dependencies recursively. it's giving "and bring your friends" 🫢
  • -dry-run β€” do not build or install, just print the locations of the generated build & install scripts. rehearsal, not the actual show 🎭
  • -list-versions β€” list available versions for the given eggs. the whole menu πŸ“œ
  • -purge β€” remove cached files for given eggs (or purge cache completely). spring cleaning, but make it filesystem 🧹
  • -host β€” when cross-compiling, only compile extensions for host.
  • -target β€” when cross-compiling, only compile extensions for target.
  • -test β€” run included test cases, if available. vibe check βœ…
  • -n, -no-install β€” do not install the egg, just build it. built different, installed never πŸ—οΈ
  • -no-install-dependencies β€” do not install dependencies. > note: this option may result in build failures due to missing extension libraries. so like... you were warned, bestie πŸ’€
  • -u, -update-db β€” update export database.
  • -repository β€” print path used for egg installation.
  • -override filename β€” override versions for installed eggs with information from filename.
  • -from-list filename β€” install eggs listed in filename, which has the same format as chicken-status(1)'s -list output. this option may be given multiple times. love a repeatable queen πŸ‘‘
  • -cached β€” only install eggs from cache, do not download. no new tabs, only the ones already open πŸ™ˆ
  • -l, -location directory β€” get egg sources from the given directory. may be provided multiple times. locations specified on the command line have precedence over the ones specified in setup.defaults πŸ—‚οΈ
  • -feature, -D name β€” register feature name, usable as a condition in cond-expand clauses. so conditional, so slay ✨

🧚 ENVIRONMENT 🧚

following environment variables change the behaviour of chicken-install:

  • CHICKEN_EGG_CACHE β€” location where eggs are retrieved and built.
  • CHICKEN_INSTALL_PREFIX β€” the path prefix for all target files, as given when building the system. use this variable to override where programs, include files and additional data files shall be installed.
  • CHICKEN_INSTALL_REPOSITORY β€” the path where extension libraries are installed. defaults to the package library path selected during configuration (usually $prefix/lib/chicken/<binary-version>). > note that this variable takes precedence to CHICKEN_INSTALL_PREFIX. she said "i'm the main character here" πŸ‘‘
  • SUDO β€” the command to execute when using -s flag in command. if not provided, defaults to sudo(8).

πŸ“ FILES πŸ“

  • $XDG_CONFIG_HOME/chicken/setup.defaults β€” user specific setup.defaults file. ($XDG_CONFIG_HOME defaults to $HOME/.config)
  • $prefix/share/chicken/setup.default β€” system-wide setup.defaults file.
  • $XDG_CACHE_HOME/chicken-install/ β€” default directory for cached eggs. ($XDG_CACHE_HOME defaults to $HOME/.cache)

⭐ EXIT STATUS ⭐

the chicken-install utility exits 0 on success, 2 if the user aborted an operation, 3 if it was invoked with no explicitly given egg names and no *.egg files could be found in the current directory, and >0 if any other error occurs. read the numbers, know the numbers πŸ”’βœ¨

🌈 EXAMPLES 🌈

install 'regex' egg as root user:

# chicken-install regex

install an egg as an normal user but using sudo(8):

$ chicken-install -s regex

install an egg as an normal user but elevating privileges with different program, such as OpenBSD doas(1):

$ SUDO=/usr/bin/doas chicken-install -s regex

see? different program, same slay πŸ’œ

🫢 SEE ALSO 🫢

chicken(1), chicken-status(1), chicken-uninstall(1), csc(1)

more information can be found in the CHICKEN User's Manual: http://wiki.call-cc.org/manual/index. iykyk πŸ“š

πŸŽ€ AUTHORS πŸŽ€

the CHICKEN Team. collectively iconic, no notes. πŸ”πŸ’–

πŸ’€ BUGS πŸ’€

submit bug reports by e-mail to chicken-janitors@nongnu.org. do it, they're nice, and honestly they want to hear from you πŸ™ˆ


and that's the page bestie!! this version came to you courtesy of Debian, dated Apr 26, 2017 β€” yes that's the date, no that's not a typo, we're just built different πŸŒΈπŸ¦‹ periodt.

πŸ“¦ where this page comes from