1
0
Fork 0
mirror of synced 2024-12-27 08:23:21 -05:00
zimfw/modules/utility/README.md
Eric Nielsen 5b90c96cd1 Update modules' README.md
Stick with the following style:

* Header 1 with the module name is in `lowercase`.
* Other headers are in `Sentence case`. Common header names that should
  be consistently used are `Aliases`, `Contributing`, `Functions`,
  `Settings`, and `Zsh options`.
* The names `Zim` and `Zsh` always appear capitalized, even in the
  middle of sentences.
* Prefer

      print 'code indented with 4 spaces'

  instead of
  ```zsh
  print 'code fenced by lines with three back-ticks'
  print 'unless you want syntax highlighting'
  ```
2018-12-17 14:11:16 -05:00

40 lines
1.1 KiB
Markdown

utility
=======
Utility aliases and functions.
Adds colour to `ls`, `grep` and `less`.
Aliases
-------
### ls
* `ls` lists directories first (GNU only) and with colour (applies to all aliases below).
* `ll` lists with long format and human-readable sizes (applies to all aliases below).
* `l` lists all files.
* `lm` lists all files using pager.
* `lr` lists recursively.
* `lx` lists sorted by extension (GNU only).
* `lk` lists sorted by largest file size last.
* `lt` lists sorted by newest modification time last.
* `lc` lists sorted by newest status change (ctime) last.
### File downloads
* `get` is short for ( `aria2c` || `axel` || `wget` || `curl` ).
### Resource usage
* `df` reports file system disk usage with human-readable sizes.
* `du` reports file disk usage with human-readable sizes.
### Condoms
* `chmod` changes file mode verbosely, not operating from `/` (GNU only).
* `chown` changes file owner verbosely, not operating from `/` (GNU only).
* `rm` uses `safe-rm` if available.
### Misc
* `mkcd` creates and changes to the given directory.