zimfw/modules/utility/README.md

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.
[utility] Use `chmod` and `chown` when in GNU Same for the `lx` alias. Also update the README.md. Replace table by bulleted list so it's possible to use `\|` in the text without breaking the Markdown rendering (as it did for the table). 2018-05-16 20:05:55 -04:00			`utility`
add utility documentation 2015-12-15 18:49:15 -05:00			`=======`

add utility aliases 2015-12-18 02:45:37 -05:00			`Utility aliases and functions.`

Add less termcap colour variables Set `less` termcap colour variables, and update the module README.md. Change the code to enclose all colour logic within a `(( ${terminfo[colors]} >= 8 ))` condition. Check if `PAGER` is set before setting the `lm` alias. Keeping the British "colour" spelling. :-) Closes #101 2016-10-28 17:17:34 -04:00			Adds colour to `ls`, `grep` and `less`.
add utility documentation 2015-12-15 18:49:15 -05:00
			`Aliases`
			`-------`

add utility aliases 2015-12-18 02:45:37 -05:00			`### ls`

[utility] Use `chmod` and `chown` when in GNU Same for the `lx` alias. Also update the README.md. Replace table by bulleted list so it's possible to use `\|` in the text without breaking the Markdown rendering (as it did for the table). 2018-05-16 20:05:55 -04:00			* `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.
add utility aliases 2015-12-18 02:45:37 -05:00
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			`### File downloads`
add utility aliases 2015-12-18 02:45:37 -05:00
[utility] Use `chmod` and `chown` when in GNU Same for the `lx` alias. Also update the README.md. Replace table by bulleted list so it's possible to use `\|` in the text without breaking the Markdown rendering (as it did for the table). 2018-05-16 20:05:55 -04:00			* `get` is short for ( `aria2c` \|\| `axel` \|\| `wget` \|\| `curl` ).
add utility aliases 2015-12-18 02:45:37 -05:00
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			`### Resource usage`
add utility documentation 2015-12-15 18:49:15 -05:00
[utility] Use `chmod` and `chown` when in GNU Same for the `lx` alias. Also update the README.md. Replace table by bulleted list so it's possible to use `\|` in the text without breaking the Markdown rendering (as it did for the table). 2018-05-16 20:05:55 -04:00			* `df` reports file system disk usage with human-readable sizes.
			* `du` reports file disk usage with human-readable sizes.
add utility documentation 2015-12-15 18:49:15 -05:00
add utility aliases 2015-12-18 02:45:37 -05:00			`### Condoms`
add utility documentation 2015-12-15 18:49:15 -05:00
[utility] Use `chmod` and `chown` when in GNU Same for the `lx` alias. Also update the README.md. Replace table by bulleted list so it's possible to use `\|` in the text without breaking the Markdown rendering (as it did for the table). 2018-05-16 20:05:55 -04:00			* `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.
add utility aliases 2015-12-18 02:45:37 -05:00
			`### Misc`

[utility] Use `chmod` and `chown` when in GNU Same for the `lx` alias. Also update the README.md. Replace table by bulleted list so it's possible to use `\|` in the text without breaking the Markdown rendering (as it did for the table). 2018-05-16 20:05:55 -04:00			* `mkcd` creates and changes to the given directory.