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