https://github.com/matu3ba/dotfiles_skeleton

robust and beginner friendly dotfile skeleton
https://github.com/matu3ba/dotfiles_skeleton

beginner-friendly dotfiles dotfiles-linux posix robust shell skeleton-template

Last synced: 4 months ago
JSON representation

robust and beginner friendly dotfile skeleton

• Host: GitHub
• URL: https://github.com/matu3ba/dotfiles_skeleton
• Owner: matu3ba
• License: mit
• Created: 2021-05-31T16:46:01.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-21T21:55:25.000Z (12 months ago)
• Last Synced: 2024-02-21T22:43:43.278Z (12 months ago)
• Topics: beginner-friendly, dotfiles, dotfiles-linux, posix, robust, shell, skeleton-template
• Language: Shell
• Homepage:
• Size: 10.7 KB
• Stars: 15
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# dotfiles

All actions in the following scripts are performed according to structure of dotfiles.

- `checkHealth.sh` shows status of files

- `fileBackup.sh` create backup to folder `$HOME/back/TIMESTAMP_backconfig` with timestamp if not symlink

- `fileRemove.sh` remove regular files, if existing on system

- `fileRestore.sh` write files, if nonexisting on system, from backup by argument the folder name

- `symlinkInstall.sh` create symlinks and also create folders with symlinks

- `symlinkUninstall.sh` remove symlinks

### Dependencies

- coreutils: http://git.savannah.gnu.org/gitweb/?p=coreutils.git (untested for other utils)

  * readlink to follow symbolic links

  * realpath to resolve non-canonical paths provided by fd-find

- fd-find: https://github.com/sharkdp/fd (cargo install fd-find) for convenient ignorelist

  * fd returns relative paths prefixed with ./ to prevent -files from modifying shell behavior

- POSIX-compatible shell, but should work on most other shells

### Usage

Make sure to place this repository in `${HOME}/dotfiles`.

If you also like that this can not be checked in POSIX, let them know.

Make sure not to mess up your `.bashrc` or equivalent of your login shell.

Keep a copy of your distro and files around on your first try to restore things.

### Path handling and file names

To set an example for proper handling, we use readlink and realpath from coreutils.

This is a fundamental limitation of any program printing folder and file names,

since `-filenames` are not considered as special.

However they can break programs.

Example: `ls "${filename}"` with filename being `-k` leading to t`ls -k`.

See also https://github.com/sharkdp/fd/issues/760 and

https://dwheeler.com/essays/fixing-unix-linux-filenames.html#dashes