= Sundae
== Synopsis
(Re)generates directories by mixing the file hierarchies contained
in various 'mounted' directories. The generated directories contain
symbolic links to the mounted files. Combined with other tools,
this scheme allows you to create separate collections of files
(work, personal, reference, linux, osx, etc.), choose which of these
you want to mount on each of your computers, and then build a
hierarchy that allows you to work on them side by side.
== Install
sudo gem install sundae
== Usage
The first time you run Sundae, it will create a template config file
in your home directory. This file, <tt>.sundae</tt>, needs to be
customized. It is in YAML format and defines the following:
[+paths+]
array; where the collections are stored
[+collection_links+]
+true+ or +false+; if true, links are created in generated
directories to the analogous location in mounted directories
[+collection_link_prefix+]
string; the prefix applied to collection links, if they are to be
created
[+ignore_rules+]
array; each line is a Regexp and becomes a rule that prevents
links to files or directories that match the Regexp
The hierarchy in <em>path</em> should look something like
this:
path/
|-- collection1/
| |-- mnt1/
| | |-- real_files_and_dirs
| | ` ...
| |-- mnt2/
`-- collection2/
` ...
For example, the hierarchy in my <em>path</em> looks sort of like this:
~/mnt/ <-- "path"
|-- osx/ <-- "collection"
| |-- home/ <-- "mnt"
| | |-- .emacs
| | |-- doc/
| | ` ...
| |-- home_library/
| | |-- .sundae_path
| | `-- Library-Keyboard_Layouts/
| | `-- Keyboard Layouts/
| | ` Colemak.keylayout
| ` ...
|-- personal
| `-- home/
| |-- doc/
| | ` ...
| ` ...
` ...
Sundae will act on all of the <em>mnt</em>s--subdirectories of the
<em>collection</em>s, that is, the sub-subdirectories of the
<em>path</em>. The "collections" are only there to facilitate
grouping common files and syncronizing them between computers.
By default, all of the contents in each of the <em>mnt</em>s are
placed in the user's home directory. This can be altered by
creating a file called <tt>.sundae_path</tt> in the top of the
<em>mnt</em>; the file should contain one line, which is the
absolute path to where that directory should be "mounted."
And that's it. When called, Sundae creates links so that you can
work on your files from seperate parts of life as if they were side
by side.
== Author
<[email protected]>
== Copyright
Copyright (c) 2008 <[email protected]>.
Licensed under the MIT License.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
== Synopsis
(Re)generates directories by mixing the file hierarchies contained
in various 'mounted' directories. The generated directories contain
symbolic links to the mounted files. Combined with other tools,
this scheme allows you to create separate collections of files
(work, personal, reference, linux, osx, etc.), choose which of these
you want to mount on each of your computers, and then build a
hierarchy that allows you to work on them side by side.
== Install
sudo gem install sundae
== Usage
The first time you run Sundae, it will create a template config file
in your home directory. This file, <tt>.sundae</tt>, needs to be
customized. It is in YAML format and defines the following:
[+paths+]
array; where the collections are stored
[+collection_links+]
+true+ or +false+; if true, links are created in generated
directories to the analogous location in mounted directories
[+collection_link_prefix+]
string; the prefix applied to collection links, if they are to be
created
[+ignore_rules+]
array; each line is a Regexp and becomes a rule that prevents
links to files or directories that match the Regexp
The hierarchy in <em>path</em> should look something like
this:
path/
|-- collection1/
| |-- mnt1/
| | |-- real_files_and_dirs
| | ` ...
| |-- mnt2/
`-- collection2/
` ...
For example, the hierarchy in my <em>path</em> looks sort of like this:
~/mnt/ <-- "path"
|-- osx/ <-- "collection"
| |-- home/ <-- "mnt"
| | |-- .emacs
| | |-- doc/
| | ` ...
| |-- home_library/
| | |-- .sundae_path
| | `-- Library-Keyboard_Layouts/
| | `-- Keyboard Layouts/
| | ` Colemak.keylayout
| ` ...
|-- personal
| `-- home/
| |-- doc/
| | ` ...
| ` ...
` ...
Sundae will act on all of the <em>mnt</em>s--subdirectories of the
<em>collection</em>s, that is, the sub-subdirectories of the
<em>path</em>. The "collections" are only there to facilitate
grouping common files and syncronizing them between computers.
By default, all of the contents in each of the <em>mnt</em>s are
placed in the user's home directory. This can be altered by
creating a file called <tt>.sundae_path</tt> in the top of the
<em>mnt</em>; the file should contain one line, which is the
absolute path to where that directory should be "mounted."
And that's it. When called, Sundae creates links so that you can
work on your files from seperate parts of life as if they were side
by side.
== Author
<[email protected]>
== Copyright
Copyright (c) 2008 <[email protected]>.
Licensed under the MIT License.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.