Mercurial > octave

annotate scripts/prefs/prefdir.m @ 23219:3ac9f9ecfae5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Update copyright dates.
author John W. Eaton <jwe@octave.org>
date Wed, 22 Feb 2017 12:39:29 -0500
parents e9a0469dedd9
children 092078913d54
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23219
3ac9f9ecfae5 maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents: 23083
diff changeset
1 ## Copyright (C) 2013-2017 John Donoghue
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
2 ##
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
3 ## This file is part of Octave.
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
4 ##
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
8 ## your option) any later version.
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
9 ##
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
13 ## General Public License for more details.
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
14 ##
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
18
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
19 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20834
diff changeset
20 ## @deftypefn {} {} prefdir
21906
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
21 ## @deftypefnx {} {} prefdir (1)
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20834
diff changeset
22 ## @deftypefnx {} {@var{dir} =} prefdir
20834
27b333c88c8e Overhaul m-files in prefs directory.
Rik <rik@octave.org>
parents: 20017
diff changeset
23 ## Return the directory that holds the preferences for Octave.
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
24 ##
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
25 ## Examples:
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
26 ##
17017
8003a4f013be Announce new prefdir, preferences functions and add to manual.
Rik <rik@octave.org>
parents: 17010
diff changeset
27 ## Display the preferences directory
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17020
diff changeset
28 ##
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
29 ## @example
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
30 ## prefdir
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
31 ## @end example
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
32 ##
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
33 ## Change to the preferences folder
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17020
diff changeset
34 ##
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
35 ## @example
17017
8003a4f013be Announce new prefdir, preferences functions and add to manual.
Rik <rik@octave.org>
parents: 17010
diff changeset
36 ## cd (prefdir)
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
37 ## @end example
21906
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
38 ##
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
39 ## If called with an argument, the preferences directory is created if it
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
40 ## doesn't already exist.
17020
960ac70ac8f3 prefdir.m: Adjust seealso references in docstring.
Rik <rik@octave.org>
parents: 17017
diff changeset
41 ## @seealso{getpref, setpref, addpref, rmpref, ispref}
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
42 ## @end deftypefn
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
43
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
44 ## Author: John Donoghue
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
45
20834
27b333c88c8e Overhaul m-files in prefs directory.
Rik <rik@octave.org>
parents: 20017
diff changeset
46 function dir = prefdir ()
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
47
20834
27b333c88c8e Overhaul m-files in prefs directory.
Rik <rik@octave.org>
parents: 20017
diff changeset
48 dir = get_home_directory ();
17017
8003a4f013be Announce new prefdir, preferences functions and add to manual.
Rik <rik@octave.org>
parents: 17010
diff changeset
49
21906
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
50 if (nargin > 0)
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
51 if (! exist (dir, "dir"))
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
52 mkdir (dir);
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
53 endif
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
54 endif
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
55
17017
8003a4f013be Announce new prefdir, preferences functions and add to manual.
Rik <rik@octave.org>
parents: 17010
diff changeset
56 endfunction