/usr/local/lib/swipl/library/settings.pl
All Application Manual Name SummaryHelp

  • swipl
    • library
      • error.pl
      • debug.pl
      • apply.pl
      • lists.pl
      • broadcast.pl -- Event service
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl
      • thread_pool.pl
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
        • setting/4
        • setting/2
        • env/2
        • env/3
        • set_setting/2
        • restore_setting/1
        • set_setting_default/2
        • load_settings/1
        • load_settings/2
        • save_settings/0
        • save_settings/1
        • current_setting/1
        • setting_property/2
        • list_settings/0
        • list_settings/1
        • convert_setting_text/3
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • readutil.pl
      • operators.pl
      • pairs.pl
      • prolog_source.pl -- Examine Prolog source-files
      • record.pl -- Access compound arguments by name
      • quasi_quotations.pl
      • pure_input.pl
      • solution_sequences.pl
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • yall.pl
      • sandbox.pl -- Sandboxed Prolog code
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl -- Binary associations
      • prolog_format.pl
      • predicate_options.pl
      • csv.pl
      • pprint.pl
      • atom.pl
      • modules.pl
      • occurs.pl
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • prolog_colour.pl -- Prolog syntax colouring support.
      • lazy_lists.pl
      • ugraphs.pl -- Graph manipulation library
      • url.pl -- Analysing and constructing URL
      • www_browser.pl
      • prolog_pack.pl
      • git.pl
      • utf8.pl
      • dialect.pl -- Support multiple Prolog dialects
      • system.pl
      • terms.pl -- Term manipulation
      • date.pl -- Process dates and times
      • persistency.pl -- Provide persistent dynamic predicates
      • iostream.pl -- Utilities to deal with streams
      • prolog_stack.pl
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_clause.pl
      • prolog_breakpoints.pl
      • wfs.pl -- Well Founded Semantics interface
      • prolog_code.pl -- Utilities for reasoning about code
      • sort.pl
      • dicts.pl
      • dif.pl -- The dif/2 constraint
      • varnumbers.pl
      • pio.pl
      • ansi_term.pl
      • backcomp.pl
      • base32.pl -- Base32 encoding and decoding
      • charsio.pl -- I/O on Lists of Character Codes
      • codesio.pl
      • coinduction.pl
      • heaps.pl
      • rbtrees.pl -- Red black trees
      • statistics.pl -- Get information about resource usage
      • when.pl -- Conditional coroutining
      • intercept.pl -- Intercept and signal interface
      • prolog_coverage.pl
      • qsave.pl
      • zip.pl
      • prolog_autoload.pl -- Autoload all dependencies
      • check.pl
      • strings.pl -- String utilities
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • threadutil.pl -- Interactive thread utilities
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • prolog_profile.pl
      • optparse.pl
      • quintus.pl
      • thread.pl -- High level thread primitives
      • ctypes.pl -- Character code classification
      • help.pl -- Text based manual
      • make.pl
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • hashtable.pl -- Hash tables
      • streams.pl
      • prolog_codewalk.pl
      • listing.pl
      • prolog_metainference.pl
      • prolog_trace.pl
      • prolog_wrap.pl -- Wrapping predicates
      • shell.pl -- Elementary shell commands
      • fastrw.pl
      • oset.pl
      • prolog_history.pl
      • prolog_config.pl
      • prolog_debug.pl -- User level debugging tools
      • edit.pl
      • tty.pl
      • writef.pl
      • nb_set.pl
      • portray_text.pl
      • explain.pl
      • files.pl
      • exceptions.pl
      • macros.pl
 setting(:Name, +Type, +Default, +Comment) is det
Define a setting. Name denotes the name of the setting, Type its type. Default is the value before it is modified. Default can refer to environment variables and can use arithmetic expressions as defined by eval_default/4.

If a second declaration for a setting is encountered, it is ignored if Type and Default are the same. Otherwise a permission_error is raised.

Arguments:
Name- Name of the setting (an atom)
Type- Type for setting. One of any or a type defined by must_be/2.
Default- Default value for the setting.
Comment- Atom containing a (short) descriptive note.