(index ("extension-name-and-version" 0) ("extension-name-and-version" 0) ("extension-name" 245) ("extension-version" 416) ("verify-extension-name" 727) ("installation-chicken-home" 934) ("installation-repository-path" 1072) ("directory-separator?" 1222) ("filename" 1439) ("make-directory-name" 1588) ("document-filename" 1837) ("source-filename" 1976) ("shared-library-filename" 2108) ("shared-filename" 2289) ("static-library-filename" 2551) ("static-filename" 2731) ("import-filename" 2887) ("source-import-filename" 3025) ("shared-import-filename" 3181) ("inline-filename" 3368) ("types-filename" 3506) ("program-filename" 3641) ("make-home-pathname" 3798) ("make-repository-pathname" 3961) ("srfi-29-bundles-home" 4142) ("make-srfi-29-bundle-directory-name" 4350) ("copy-file-relative" 4702) ("copy-file-absolute" 4901) ("copy-to-repository" 5164) ("copy-to-home" 5336) ("file-chmod" 5576) ("compile-static" 5874) ("compile-shared" 6101) ("compile-static-module" 6266) ("compile-shared-module" 6502) ("install-in-repository" 6700) ("install-in-home" 6873) ("install-srfi-29-bundle" 7028) ("install-static-extension" 7502) ("install-shared-extension" 7690) ("install-static-extension-module" 7878) ("install-shared-extension-module" 8087) ("install-shared+static-extension-module" 8296) ("install-extension-tag" 8551) ("setup-static-extension" 8720) ("setup-shared-extension" 8988) ("setup-static-extension-module" 9256) ("setup-shared-extension-module" 9545) ("setup-shared+static-extension-module" 9834) ("default-static-compile-options" 10444) ("default-static-compile-options" 10444) ("default-shared-compile-options" 10713) ("default-shared-compile-options" 10713) ("default-import-compile-options" 10987) ("default-import-compile-options" 10987) ("default-static-install-options" 11294) ("default-static-install-options" 11294) ("default-static-install-options" 11496) ("default-static-install-options" 11496) ("default-static-module-install-options" 11698) ("default-static-module-install-options" 11698) ("default-shared-module-install-options" 11928) ("default-shared-module-install-options" 11928) ("default-shared+static-module-install-options" 12158) ("default-shared+static-module-install-options" 12158))
(def (sig (parameter "(extension-name-and-version) => list" (id extension-name-and-version)) (parameter "(extension-name-and-version NAME+VERSION)" (id extension-name-and-version))) (p (tt "NAME+VERSION") " is " (tt "(list NAME VERSION)") "."))
(def (sig (procedure "(extension-name) => string" (id extension-name))) (p "Returns the " (tt "extension-name") " component of " (tt "(extension-name-and-version)") "."))
(def (sig (procedure "(extension-version [DEFAULT]) => string" (id extension-version))) (p "Returns the " (tt "extension-version") " component of " (tt "(extension-name-and-version)") ".") (p "Should the " (tt "(second (extension-name-and-version))") " be " (i "empty") " the " (tt "DEFAULT") " is returned."))
(def (sig (procedure "(verify-extension-name NAME)" (id verify-extension-name))) (p "Raises an error should " (b (tt "chicken-install")) " know the extension by a different name.") (p "Use when paranoid."))
(def (sig (procedure "(installation-chicken-home) => string" (id installation-chicken-home))) (p "Returns the " (tt "INSTALL-HOME") "."))
(def (sig (procedure "(installation-repository-path) => string" (id installation-repository-path))) (p "Returns the " (tt "INSTALL-REPOSITORY") "."))
(def (sig (procedure "(directory-separator? X) => boolean" (id directory-separator?))) (p "Is " (tt "X") " a directory separator?") (p (tt "X") " is a " (tt "string") ", " (tt "character") ", or " (tt "symbol") "."))
(def (sig (procedure "(filename FILE [EXTENSION]) => string" (id filename))) (p "Returns a filename for " (tt "FILE") " and " (tt "EXTENSION") "."))
(def (sig (procedure "(make-directory-name DIRECTORY) => string" (id make-directory-name))) (p "Returns a dirname, ensuring no trailing directory separator.") (p (tt "DIRECTORY") " is a " (tt "string") ", " (tt "symbol") ", or a " (tt "list") "."))
(def (sig (procedure "(document-filename FILE) => string" (id document-filename))) (p "Returns a \"html\" filename for " (tt "FILE") "."))
(def (sig (procedure "(source-filename FILE) => string" (id source-filename))) (p "Returns \"scm\" filename for " (tt "FILE") "."))
(def (sig (procedure "(shared-library-filename FILE) => string" (id shared-library-filename))) (p "Returns a platform-specific dynamic-link-library filename for " (tt "FILE") "."))
(def (sig (procedure "(shared-filename FILE) => string" (id shared-filename))) (p "Returns a platform-specific dynamic-load-file filename for " (tt "FILE") ".") (p (i "Note") " this superfluous now as all shared binaries have the " (tt "\"so\"") " extension."))
(def (sig (procedure "(static-library-filename FILE) => string" (id static-library-filename))) (p "Returns a platform-specific static-link-library filename for " (tt "FILE") "."))
(def (sig (procedure "(static-filename FILE) => string" (id static-filename))) (p "Returns a platform-specific object-file filename for " (tt "FILE") "."))
(def (sig (procedure "(import-filename FILE) => string" (id import-filename))) (p "Returns an \"import\" filename for " (tt "FILE") "."))
(def (sig (procedure "(source-import-filename FILE) => string" (id source-import-filename))) (p "Returns an \"import.scm\" filename for " (tt "FILE") "."))
(def (sig (procedure "(shared-import-filename FILE) => string" (id shared-import-filename))) (p "Returns a platform-specific dynamic-load-file \"import\" filename for " (tt "FILE") "."))
(def (sig (procedure "(inline-filename FILE) => string" (id inline-filename))) (p "Returns an \"inline\" filename for " (tt "FILE") "."))
(def (sig (procedure "(types-filename FILE) => string" (id types-filename))) (p "Returns an \"types\" filename for " (tt "FILE") "."))
(def (sig (procedure "(program-filename FILE) => string" (id program-filename))) (p "Returns a platform-specific executable filename for " (tt "FILE") "."))
(def (sig (procedure "(make-home-pathname FILE) => string" (id make-home-pathname))) (p "Returns a pathname for " (tt "FILE") " in the " (tt "INSTALL-HOME") "."))
(def (sig (procedure "(make-repository-pathname FILE) => string" (id make-repository-pathname))) (p "Returns a pathname for " (tt "FILE") " in the " (tt "INSTALL-REPOSITORY") "."))
(def (sig (procedure "(srfi-29-bundles-home) => string" (id srfi-29-bundles-home))) (p "Returns the root dirname for SRFI 29 bundles.") (p "Please see the " (int-link "srfi-29") " extension documentation."))
(def (sig (procedure "(make-srfi-29-bundle-directory-name SPEC) => string" (id make-srfi-29-bundle-directory-name))) (p "Returns the SRFI 29 bundle installation dirname for the supplied " (tt "SPEC") ".") (p (tt "SPEC") " is a " (tt "list BUNDLE-SPECIFICATION-COMPONENT...") ".") (p "Please see the " (int-link "srfi-29") " extension documentation."))
(def (sig (procedure "(copy-file-relative FILENAME DIRECTORY)" (id copy-file-relative))) (p "Copies the file " (tt "FILENAME") " to the " (tt "DIRECTORY") ". The " (tt "DIRECTORY") " be relative."))
(def (sig (procedure "(copy-file-absolute FILENAME DIRECTORY)" (id copy-file-absolute))) (p "Copies the file " (tt "FILENAME") " to the " (tt "DIRECTORY") ". Should the " (tt "DIRECTORY") " be relative it will be coerced to absolute (by " (tt "copy-file") ")."))
(def (sig (procedure "(copy-to-repository FILENAME)" (id copy-to-repository))) (p "Copies the local file " (tt "FILENAME") " to the " (i (tt "(chicken-repository)")) "."))
(def (sig (procedure "(copy-to-home FILENAME)" (id copy-to-home))) (p "Copies the local file " (tt "FILENAME") " to the directory " (i (tt "(installation-prefix) share chicken")) ". This is usually the same as " (tt "(chicken-home)") "."))
(def (sig (procedure "(file-chmod FILENAME MODE)" (id file-chmod))) (p "Modifies the filemode of " (tt "FILENAME") " to the " (tt "MODE") " symbol.") (p (tt "MODE") " is a symbol form of the \"chmod\" mode syntax. Ex: " (tt "'a+rx")) (p "Correctly handles a true " (tt "(sudo-install)") " mode."))
(def (sig (procedure "(compile-static NAME [#:options COMPILE-OPTIONS] [#:inline? INLINE?] [#:types? TYPES?])" (id compile-static))) (p "Compiles to object file with unit-name " (tt "NAME") ".") (p "No linking is performed!"))
(def (sig (procedure "(compile-shared NAME [#:options COMPILE-OPTIONS] [#:inline? INLINE?] [#:types? TYPES?])" (id compile-shared))) (p "Compiles to shared file."))
(def (sig (procedure "(compile-static-module NAME [#:options COMPILE-OPTIONS] [#:inline? INLINE?] [#:types? TYPES?])" (id compile-static-module))) (p "Compiles to object file with unit-name " (tt "NAME") " and import to shared file."))
(def (sig (procedure "(compile-shared-module NAME [#:options COMPILE-OPTIONS] [#:inline? INLINE?] [#:types? TYPES?])" (id compile-shared-module))) (p "Compiles source and import to shared files."))
(def (sig (procedure "(install-in-repository FILENAME)" (id install-in-repository))) (p "Like " (tt "copy-to-repository") " but observes the " (i "no-install") " status."))
(def (sig (procedure "(install-in-home FILENAME)" (id install-in-home))) (p "Like " (tt "copy-to-home") " but observes the " (i "no-install") " status."))
(def (sig (procedure "(install-srfi-29-bundle NAME [BUNDLE-SPECIFICATION-COMPONENT...])" (id install-srfi-29-bundle))) (p "Copies the local SRFI 29 bundle to the " (tt "(srfi-29-bundle-directory)") ".") (p "The bundle is a single file with " (tt "NAME") " that may be at the bottom of a " (tt "BUNDLE-SPECIFICATION-COMPONENT") " hierarchy.") (p "Each directory in the " (tt "BUNDLE-SPECIFICATION") " filesystem representation has a filemode of 'a+rx'. (non-windows only)"))
(def (sig (procedure "(install-static-extension NAME VERSION [#:options INSTALL-OPTIONS] [#:files FILENAMES])" (id install-static-extension))) (p "Installs a compiled-static-extension."))
(def (sig (procedure "(install-shared-extension NAME VERSION [#:options INSTALL-OPTIONS] [#:files FILENAMES])" (id install-shared-extension))) (p "Installs a compiled-shared-extension."))
(def (sig (procedure "(install-static-extension-module NAME VERSION [#:options INSTALL-OPTIONS] [#:files FILENAMES])" (id install-static-extension-module))) (p "Installs a compiled-static-extension-module."))
(def (sig (procedure "(install-shared-extension-module NAME VERSION [#:options INSTALL-OPTIONS] [#:files FILENAMES])" (id install-shared-extension-module))) (p "Installs a compiled-shared-extension-module."))
(def (sig (procedure "(install-shared+static-extension-module NAME VERSION [#:options INSTALL-OPTIONS] [#:files FILENAMES])" (id install-shared+static-extension-module))) (p "Installs a compiled-shared-extension-module and a compiled-static-extension."))
(def (sig (procedure "(install-extension-tag NAME VERSION)" (id install-extension-tag))) (p "Installs an empty extension with " (tt "NAME") " and " (tt "VERSION") "."))
(def (sig (procedure "(setup-static-extension NAME VERSION [#:compile-options COMPILE-OPTIONS] [#:inline? INLINE?] [#:types? TYPES?] [#:install-options INSTALL-OPTIONS] [#:files FILENAMES])" (id setup-static-extension))) (p "Compiles & installs a static-extension."))
(def (sig (procedure "(setup-shared-extension NAME VERSION [#:compile-options COMPILE-OPTIONS] [#:inline? INLINE?] [#:types? TYPES?] [#:install-options INSTALL-OPTIONS] [#:files FILENAMES])" (id setup-shared-extension))) (p "Compiles & installs a shared-extension."))
(def (sig (procedure "(setup-static-extension-module NAME VERSION [#:compile-options COMPILE-OPTIONS] [#:inline? INLINE?] [#:types? TYPES?] [#:install-options INSTALL-OPTIONS] [#:files FILENAMES])" (id setup-static-extension-module))) (p "Compiles & installs a static-extension-module."))
(def (sig (procedure "(setup-shared-extension-module NAME VERSION [#:compile-options COMPILE-OPTIONS] [#:inline? INLINE?] [#:types? TYPES?] [#:install-options INSTALL-OPTIONS] [#:files FILENAMES])" (id setup-shared-extension-module))) (p "Compiles & installs a shared-extension-module."))
(def (sig (procedure "(setup-shared+static-extension-module NAME VERSION [#:compile-options COMPILE-OPTIONS] [#:shared-compile-options COMPILE-OPTIONS] [#:static-compile-options COMPILE-OPTIONS] [#:inline? INLINE?] [#:types? TYPES?] [#:install-options INSTALL-OPTIONS] [#:files FILENAMES])" (id setup-shared+static-extension-module))) (p "Compiles & installs a shared-extension-module and a static-extension.") (p "The " (tt "COMPILE-OPTIONS") ", " (tt "INLINE?") ", AND " (tt "TYPES?") " are applied to both the shared and static builds. As such the " (tt "-o|-output-file'") " option cannot be supported."))
(def (sig (parameter "(default-static-compile-options) => list" (id default-static-compile-options)) (parameter "(default-static-compile-options COMPILE-OPTIONS)" (id default-static-compile-options))) (p "Built-in is " (tt "(-c -optimize-leaf-routines -inline)") "."))
(def (sig (parameter "(default-shared-compile-options) => list" (id default-shared-compile-options)) (parameter "(default-shared-compile-options COMPILE-OPTIONS)" (id default-shared-compile-options))) (p "Built-in is " (tt "(-shared -optimize-leaf-routines -inline)") "."))
(def (sig (parameter "(default-import-compile-options) => list" (id default-import-compile-options)) (parameter "(default-import-compile-options COMPILE-OPTIONS)" (id default-import-compile-options))) (p "Built-in is " (tt "(-shared -optimize-leaf-routines -local -inline -no-trace -no-lambda-info)") "."))
(def (sig (parameter "(default-static-install-options) => list" (id default-static-install-options)) (parameter "(default-static-install-options INSTALL-OPTIONS)" (id default-static-install-options))))
(def (sig (parameter "(default-static-install-options) => list" (id default-static-install-options)) (parameter "(default-static-install-options INSTALL-OPTIONS)" (id default-static-install-options))))
(def (sig (parameter "(default-static-module-install-options) => list" (id default-static-module-install-options)) (parameter "(default-static-module-install-options INSTALL-OPTIONS)" (id default-static-module-install-options))))
(def (sig (parameter "(default-shared-module-install-options) => list" (id default-shared-module-install-options)) (parameter "(default-shared-module-install-options INSTALL-OPTIONS)" (id default-shared-module-install-options))))
(def (sig (parameter "(default-shared+static-module-install-options) => list" (id default-shared+static-module-install-options)) (parameter "(default-shared+static-module-install-options INSTALL-OPTIONS)" (id default-shared+static-module-install-options))))
