Last modified: December 2013

URL: https://cxc.cfa.harvard.edu/chips/ahelp/save_preferences.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.11 ChIPS v1

save_preferences

Context: preference

Synopsis

Saves ChIPS preferences to a file.

Syntax

save_preferences()
save_preferences(filename)

Description

The function arguments.

Argument Description
filename The file name to write to.

The save_preferences command saves ChIPS preferences to the specified file. If not specified, uses "$HOME/.chips.rc".

If the output file exists, ChIPS behavior is determined by the value of the export.clobber preference. If export.clobber is set to true, ChIPS will attempt to overwrite the existing file.

The preferences can be loaded into a new ChIPS session with the load_preferences command.

See "ahelp preferences" for general information on the attribute values and settings in ChIPS.


Examples

Example 1

chips> save_preferences()

Save preferences to the file "$HOME/.chips.rc". If the file already exits then setting the export.clobber preference to true will cause the file to be over-written (but note that this new setting for export.clobber will be saved to your preferences file!):

chips> set_preference("export.clobber", "true")

Example 2

chips> save_preferences("/some/path/chips.pref")

Save preferences to the file "/some/path/chips.pref".


Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.

See Also

concepts
preferences
preference
get_preference, get_preferences, load_preferences, set_preference, set_preference_autoload, set_preferences