README 3.4 KB

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