diff --git a/pages/common/boxxy.md b/pages/common/boxxy.md new file mode 100644 index 0000000000..10918e4c69 --- /dev/null +++ b/pages/common/boxxy.md @@ -0,0 +1,28 @@ +# boxxy + +> Redirect file locations for programs that don't respect the XDG standards. +> More information: . + +- Run a program with file redirections defined in `~/.config/boxxy/boxxy.yaml`: + +`boxxy {{program}}` + +- Scan your home directory for rule suggestions: + +`boxxy scan` + +- Trace what files a program touches and save a report in `boxxy-report.txt` in the current directory: + +`boxxy {{[-t|--trace]}} {{program}}` + +- Pass a redirection rule directly on the terminal: + +`boxxy {{[-r|--rule]}} {{path/to/file_or_directory}}:{{path/to/redirection}}:{{file|directory}} {{program}}` + +- View the config file: + +`boxxy config` + +- Display help: + +`boxxy -h`