GAUCHE-INSTALL(1)

πŸ“¦
version 0.9.15-p2+20241205 Β· 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– GAUCHE-INSTALL(1) πŸ’–

okay so bestie, welcome to the Gauche Commands corner of the manual β€” this one's gauche-install, and it's genuinely the friend that shows up to help you move.


✨ NAME ✨

gauche-install β€” install files and set attributes 🫢


🌸 SYNOPSIS 🌸

 1)* gauche-install [OPTION...] FILE DEST
 2)* gauche-install [OPTION...] FILE... DIRECTORY
 3)* gauche-install -d [OPTION...] DIRECTORY...
 4)  gauche-install -T DIRECTORY [OPTION...] FILE...
 5)  gauche-install -U DIRECTORY [OPTION...] FILE...

πŸ¦‹ DESCRIPTION πŸ¦‹

gauche-install is a program to install and remove files. When it installs, it can also set ownership and permissions. No cap β€” this command is upward compatible with BSD install(1) and can be used as a drop-in replacement for it. And notably? The 1st, 2nd and 3rd command-line formats above are the ones that line up with BSD install.

This command exists mainly so Gauche's extension packages can have a simpler installation and configuration process. Because those packages can just know that gauche-install is available, they don't have to stress about the subtle little differences between all the various install(1) commands out there. iconic behaviour honestly.

  • The first format copies FILE on the file, or into the directory, named by DEST.
  • The second format copies FILE ... into the directory DIRECTORY.
  • The third format makes sure DIRECTORY exists. If it doesn't, the command creates the path to the DIRECTORY, including any intermediate ones.
  • The fourth format installs FILE ... to the DIRECTORY. It's more convenient than the first and second formats in these regards:
    • If the destination directory does not exist, it is created (with any intermediate paths as needed).
    • The list of files can be empty, so that when the list of installed files can be generated by configuration, you don't need to handle the empty case specially in a Makefile. (With the BSD install format, an empty file list yields an error. πŸ’€)
    • The directory prefix of files are preserved within the destination directory. This is handy to install a subtree of files. For example, the following command installs /usr/share/foo/main, /usr/share/foo/conf/x and /usr/share/foo/conf/y with a single command.
gauche-install -T /usr/share/foo main conf/x conf/y

Giving the -p option suppresses this behavior and strips any directory prefix, like the second format. The following command line installs /usr/share/foo/main, /usr/share/foo/x and /usr/share/foo/y.

gauche-install -T /usr/share/foo -p main conf/x conf/y
  • The fifth format removes FILE ... in the DIRECTORY. Irrelevant options are ignored, so it is handy to uninstall files just by changing -T in the fourth format to -U. One letter. That's the whole uninstall. obsessed.

πŸ’… OPTIONS πŸ’…

  • -C, --canonical-suffix β€” this one is used specially to install Gauche's autogenerated Scheme source by experimental precompilation. The generated file has a *.sci. Upon installation, this command replaces the suffix for *.scm.
  • -d, --directory β€” creates directories. (3rd format only). It is only for the compatibility. Using the -T option, the destination directories are created automatically if missing.
  • -g, --group=GROUP β€” change group of the installed file.
  • -h, --help β€” show summary of options.
  • -m, --mode=MODE β€” change mode of the installed file.
  • -n, --dry-run β€” just prints what actions to be done.
  • -o, --owner=OWNER β€” change owner of the installed file.
  • -p, --strip-prefix=PREFIX β€” strip PREFIX directories from FILE(s) before installation. (4th/5th format only).
  • --shebang=PATH β€” adds #!PATH before the file contents. Useful to install scripts. 🐍✨
  • -S, --srcdir=directory β€” look for files within directory; useful if VPATH is used in Makefiles.
  • -T, --target=directory β€” installs files to the directory, creating paths if needed. Partial path of files are preserved unless -p option is given. (4th format only)
  • -U, --uninstall=directory β€” reverse of -T, e.g. removes files from its destination. Other options (except -h and -n) are ignored.
  • -v, --verbose β€” work verbosely.

🌈 DIAGNOSTICS 🌈

gauche-install exits with status 0 on success. that's it, that's the whole vibe check.


⭐ SEE ALSO ⭐

gauche-package(1), install(1)

The program will be documented fully by the Gauche DevelopersΒ΄ Reference available via the info(1) system. πŸ“–


πŸ‘‘ AUTHORS πŸ‘‘

  • Shiro Kawai <shiro@acm.org>
    • Author.
  • Jens Thiele <karme@karme.de>
    • Wrote this manpage for the Debian system.

Copyright Β© 2010 Jens Thiele

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without any warranty.

fr fr on the "without any warranty" part β€” no take-backsies, bestie.

and that's the whole page, mwah πŸ’‹ β€” this was Gauche 0.9.15-p2, aka the version you're reading about right now. bye bestie, go install something cute πŸ¦‹

πŸ“¦ where this page comes from