Project 「整」

It's a bash script project that aims to maintain dotfiles. (inspired by stow)

***********************************
*** IT'S VERY EXPERIMENTAL NOW! ***
***********************************

中文简体 | 中文繁體

About the name

The project name is 整 (Unicode: U+6574; pinyin: zhěng). The number of it's strokes is 16, so I use z16 as the English name.

整 is a Chinese character, although it can mean many things, I choose it because it can mean the following:

• do something
• orderly
• neat
• tidy
• sounds agile
• and concise

Installation & Run

• Gentoo Linux

  eselect repository enable ryans #or `layman -a ryans && layman -S`
  echo "\napp-admin/z16 **" >> /etc/portage/package.accept_keywords
  emerge -av app-admin/z16
  z16

• Others

  git clone https://github.com/bekcpear/z16.git
  cd z16
  ./z16.sh

Examples

Load all files that belong to instance etc, home-misc and vim:

z16 load etc home-misc vim

Load all files that belong to instance etc to the remote server via ssh and keep the connection for 30 minutes:

z16 -s alice@my.azure -i ~/.ssh/alice.key -k30M load etc

Unload all files that belong to instance home-misc:

z16 unload home-misc

Workflow & How to use it

1. Ensure that z16 can read its configuration file:

   z16 #default to show help message

   z16 will check its system-wide configuration file first, and then check its user-level configuration file.

   If both configuration files do not exist, z16 will prompt to initalize itself.

   For more detailed instructions, please see the How to configure section below.

2. Initialize instance(s):

   z16 init <a-instance> [<more-instances>...]

   When initializing instances, z16 will get the path of directory which contains instances from its basic configuration file.

   And then, z16 will create the instance directory under the path (the directory name is the same as the instance name) and make a commented local configuration file for this instance.

3. Put your files in the proper instance directory, and modify the local configuration file of the instance, especially the parentdir config.

4. Now you can load the configured instance(s):

   z16 load <configured-instance> [<more-configured-instances>...]

   z16 will:

   1. create symbolic links in a temporary directory for all files under the instance directory iteratively (except the local configuration file and ignored files which configured), and replace the prefix dot-(case-insensitive) of filenames/directories to ..
   2. change the ownership of symbolic links and its target files to configured user/group or current effective user/group.
   3. if everything is ok, z16 will merge temporary created symbolic links to the root filesystem. If -s option used, z16 will push the original file to the configured corresponding path of the server.

• unload command is used to unlink all symbolic links belonging to given instance(s) directly, and remove all empty directories which belong to instance configured parent path:

  z16 unload <configured-instance> [<more-configured-instances>...]

• At present, if you want rename instances, please do --force load after the instance directory has been renamed.

How to configure

z16 has several configuration files:

1. the basic configuration file

   1. system-wide, /etc/z16/z16rc
   2. user-level, default to ${HOME}/.config/z16/z16rc

   At present, the above two configuration files are used to configure:

   • the path of the directory that storing all instances, default to ${HOME}/.local/share/z16
   • the name of the global configuration file for all instances, default to .z16.g.conf

   User-level configuration file will override the same configurations that have been set in the system-wide configuration file.

   At least one of the above two files exists.

2. global configuration file for all instances, <instances-container-dir>/<global-conf-filename>

   At present, this configuration files are used to configure:

   • the name of the local configuration file for every instance, default to .z16.l.conf
   • default parent directory of every instance, it is usually set to a safe path to prevent the system file from possibly being damaged due to the missing parent directory configuration of instance. default to /tmp/z16.tmp.d
   • the user of symbolic links and its target files of the instance, default to current effective user
   • the group of symbolic links and its target files of the instance, default to current effective group
   • comma-seperated ignored file patterns of all instances, every pattern is a POSIX extended regular expression

3. local configuration file for the instance, <the-instance-dir>/<local-conf-filename>

   At present, this configuration files are used to configure:

   • parent directory of this instance, this config should be set everytime the instance initialized
   • the user of symbolic links and its target files of this instance, default to the global user setting
   • the group of symbolic links and its target files of this instance, default to the global group setting
   • comma-seperated ignored file patterns of the current instance, every pattern is a POSIX extended regular expression

The configuration of ignored file patterns are cumulative (the local configuration includes the global ignored configurations). An ! prefixed pattern is used to remove all exactly matched patterns that have been added before it.

LICENSE

GPLv2