| Type: | Package | 
| Title: | 'Rcpp' Interface for Querying System Configuration Variables | 
| Version: | 0.0.4 | 
| Date: | 2025-01-07 | 
| Description: | The 'getconf' command-line tool provided by 'libc' allows querying of a large number of system variables. This package provides similar functionality. | 
| URL: | https://github.com/eddelbuettel/rcppgetconf, https://dirk.eddelbuettel.com/code/rcpp.getconf.html | 
| BugReports: | https://github.com/eddelbuettel/rcppgetconf/issues | 
| Imports: | Rcpp | 
| LinkingTo: | Rcpp | 
| SystemRequirements: | A POSIX system. Currently Linux and macOS are known to work. | 
| OS_type: | unix | 
| License: | GPL-2 | GPL-3 [expanded from: GPL (≥ 2)] | 
| Encoding: | UTF-8 | 
| RoxygenNote: | 6.0.1 | 
| NeedsCompilation: | yes | 
| Packaged: | 2025-01-07 12:38:04 UTC; edd | 
| Author: | Dirk Eddelbuettel | 
| Maintainer: | Dirk Eddelbuettel <edd@debian.org> | 
| Repository: | CRAN | 
| Date/Publication: | 2025-01-08 10:40:02 UTC | 
Return all System Configuration Settings
Description
Retrieve all configuration settings
Usage
getAll(path = ".")
Arguments
| path | An optional character object specifying a path. Default is the current directory. | 
Details
This functions returns all configuration settings which can be queried
in a data.frame object. The system-level functions sysconf,
pathconf and confstr provide all the underlying information.
Value
A data.frame with three colums for key, value and (source) type.
Not all keys return a value; in those cases an empty string is returned.
Type is one of path, sys and conf and signals how the
value was obtained.
Author(s)
Dirk Eddelbuettel
See Also
Examples
if (Sys.info()[["sysname"]] != "SunOS") {
    head(getAll(), 30)
    subset(getAll(), type=="path")
}
Return a System Configuration Setting
Description
Retrieve one configuration setting
Usage
getConfig(var, path = ".")
Arguments
| var | An character object specifying a value for which configuration is queried. | 
| path | An optional character object specifying a path. Default is the current directory. | 
Details
This functions returns the configuration setting for a given input.
in a data.frame object. The system-level functions sysconf,
pathconf and confstr provide the underlying information.
Value
A result value corresponding to the requested setting. The return type can be either integer for a numeric value, character for text or NULL in case to value could be retrieved.
Author(s)
Dirk Eddelbuettel
See Also
Examples
if (Sys.info()[["sysname"]] != "SunOS") {
    getConfig("_NPROCESSORS_CONF")   # number of processor
    getConfig("LEVEL1_ICACHE_SIZE")  # leve1 cache size
    getConfig("GNU_LIBC_VERSION")    # libc version
}