Skip to content
This repository

DotFS allows per-host configuration by providing dotfiles on a virtual FS.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 System
Octocat-spinner-32 examples
Octocat-spinner-32 initscript
Octocat-spinner-32 test
Octocat-spinner-32 .ghci
Octocat-spinner-32 .gitignore
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Setup.hs
Octocat-spinner-32 TODO
Octocat-spinner-32 dotfs.cabal
README.md

DOTFS

DotFS is first and foremost a work in progress. It is, however, usable, and the authors use it on their personal machines. The idea is that you point DotFS to a folder containing your dotfiles containing special DotFS annotations, which will then be made available as a virtual filesystem at a user-specified mountpoint. The files will be scanned for special keywords and presented on the virtual filesystem, possibly configured per-host or per-OS, however you like. The use case is a user wanting automatic configuration adjustment in larger config files with shared sections. See the wiki for a quick guide, a users' guide, a specification of the grammar, and some examples.

Note that if a file doesn't contain DotFS markup, it is passed through "vanilla" — this includes binaries. This means that you don't have to convert all your config files before starting with DotFS, but that you can annotate those which currently pose an inconvenience, and leave all the others as they are.

Requirements

  • POSIX system
  • FUSE (or OSXFUSE)
  • GHC (Haskell platform recommended)
  • Tested on Linux, hfuse needs to be un-broken on OS X

Installation

First install some dependencies (example is for Debian-like systems):

NOTE to OS X users: the HFuse library, on which we depend, doesn't build using the latest OSXFUSE library. Please use the patched version fork for now, until the pull request is hopefully accepted.

sudo apt-get install libfuse-dev fuse-utils

Install DotFS, or run from the local directory using make and then ./dotfs.

cabal configure
cabal install

Usage

See the wiki entry on usage. Soon a short presentation will also be put online which will hopefully serve as both an elevator pitch and a short introduction to the features that are available. See here.

Interesting pointers

Something went wrong with that request. Please try again.