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

  • swipl
    • library
      • error.pl
      • debug.pl
      • apply.pl
      • lists.pl
      • broadcast.pl
      • shlib.pl
      • option.pl
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl
      • 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
      • main.pl
      • readutil.pl
      • operators.pl
      • pairs.pl
      • prolog_source.pl -- Examine Prolog source-files
      • record.pl
      • quasi_quotations.pl
      • pure_input.pl
      • solution_sequences.pl
      • ordsets.pl
      • random.pl
      • base64.pl
      • aggregate.pl
      • yall.pl
      • sandbox.pl
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl
      • prolog_format.pl
      • predicate_options.pl
      • csv.pl
      • pprint.pl
      • atom.pl
      • modules.pl
      • occurs.pl
      • prolog_xref.pl
      • prolog_colour.pl
      • lazy_lists.pl
      • ugraphs.pl
      • url.pl
      • www_browser.pl
      • prolog_pack.pl
      • git.pl
      • utf8.pl
      • dialect.pl
      • system.pl
      • terms.pl
      • date.pl
      • persistency.pl
      • iostream.pl -- Utilities to deal with streams
      • prolog_stack.pl -- Examine the Prolog stack
      • edinburgh.pl
      • prolog_clause.pl
      • prolog_breakpoints.pl
      • wfs.pl
      • prolog_code.pl -- Utilities for reasoning about code
      • sort.pl
      • dicts.pl
      • dif.pl
      • varnumbers.pl
      • pio.pl
      • exceptions.pl
      • rbtrees.pl
      • statistics.pl
      • backcomp.pl
      • codesio.pl
      • base32.pl
      • charsio.pl -- I/O on Lists of Character Codes
      • coinduction.pl
      • heaps.pl
      • when.pl
      • strings.pl -- String utilities
      • ctypes.pl -- Character code classification
      • streams.pl
      • hashtable.pl
      • listing.pl -- List programs and pretty print clauses
      • check.pl
      • thread.pl
      • ansi_term.pl
      • threadutil.pl -- Interactive thread utilities
      • nb_set.pl -- Non-backtrackable sets
      • help.pl
      • qsave.pl
      • zip.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.