README (raw) (3442B)
1 NAME 2 dotfm - a simple script to manage dotfiles. 3 4 SYNOPSIS 5 dotfm [-h] [-d] [-v] [-q] COMMAND DOTFILE... 6 7 DESCRIPTION 8 dotfm is designed to be simple and easy to use. It's really just a 9 short-hand for managing symlinks of dotfiles (it's also helpful if 10 you don't want to remember or type out the location of a dotfile 11 everytime you want to modify it). 12 13 ARGUMENTS 14 -h --help Displays help printout 15 -s --skip Skip prompts where necessary and just use defaults 16 -d --debug Display debug logs 17 -v --version Display dotfm version 18 -q --quiet Tell dotfm to shutup (hide info logs) 19 20 COMMANDS 21 Multiple DOTFILE args can be passed to each command. 22 23 Some terminology to avoid confusion: 24 - DOTFILE refers to the filepath of the dotfile to be installed 25 - DESTINATION refers to the location you would usually find a 26 dotfile at. For example, the location for bashrc is ~/.bashrc 27 - ALIAS refers to any name used to call a dotfile installed by 28 dotfm. dotfm recognises the source filepath (DOTFILE) as an alias 29 30 install, in <DOTFILE> ... 31 Create a symlink to DOTFILE from it's DESTINATION and register it. 32 DOTFILE should be the filepath of the dotfile to install. If this 33 path matches its DESTINATION, then a symlink won't be created but 34 the file will still be registered by dotfm. 35 36 If DOTFILE is recognised by dotfm, then you will be prompted for 37 an install location and aliases to call the dotfile by. If the 38 --skip option was passed then the defaults will be used. 39 40 update, up <ALIAS> <DOTFILE> 41 update the source DOTFILE path (of the dotfm-registered dotfile 42 matching ALIAS) that DESTINATION points to. 43 44 link, ln <FILE> ... 45 hardlink FILE to another destination, ideally a repository with a 46 collection of your dotfiles. 47 48 remove, rm <ALIAS> ... 49 If ALIAS is recognised, then the DESTINATION of the dotfile will be 50 removed. This is a destructive function, use it carefully. 51 52 Will only remove the file if the file has been installed by dotfm 53 (and can be found in DOTFM CSV FILE). 54 55 edit, ed <ALIAS> ... 56 Open DOTFILE in $EDITOR or nano if $EDITOR is not present. 57 58 DOTFILE should be an alias of the dotfile to edit. 59 60 list, ls <ALIAS> ... 61 Print a table of the install locations and aliases for all 62 registered dotfiles. If one or more DOTFILE arguments are present, 63 then only dotfiles with matching aliases will be listed. 64 65 INSTALL 66 Go to the source folder of dotfm and run "sudo make install" or "sudo 67 make link". 68 - "sudo make install" - copy dotfm to the install location (recommended 69 for most users). 70 - "sudo make link" - create a symlink of dotfm from its current location 71 to the install location (useful for development). 72 73 By default the install location of dotfm is /usr/local/bin/dotfm. To 74 modify this, just edit the value of DESTBINDIR in the Makefile. 75 76 UNINSTALL 77 Go to the source folder of dotfm and run "sudo make uninstall". 78 79 ENVIRONMENT 80 EDITOR The text editor to edit dotfiles with. If not present, 81 nano will be used. 82 HOME The home directory of the current user 83 DFMDIR The directory in which your collection of dotfiles live. 84 85 HINTS 86 I would recommend modifying the "KNOWN" array in src/ dotfm.py 87 to suite your own needs if i've missed any dotfiles you frequently use. 88 89 AUTHORS & CONTRIBUTORS 90 - gearsix <gearsix@tuta.io> = original author 91 - marta dias - https://www.instagram.com/marta.dias.z/ = the logo 92