docs: update
This commit is contained in:
32
README.md
32
README.md
@@ -14,6 +14,8 @@ A collection of pure POSIX `sh` alternatives to external processes
|
|||||||
* [Check if string contains a sub-string](#check-if-string-contains-a-sub-string)
|
* [Check if string contains a sub-string](#check-if-string-contains-a-sub-string)
|
||||||
* [Check if string starts with sub-string](#check-if-string-starts-with-sub-string)
|
* [Check if string starts with sub-string](#check-if-string-starts-with-sub-string)
|
||||||
* [Check if string ends with sub-string](#check-if-string-ends-with-sub-string)
|
* [Check if string ends with sub-string](#check-if-string-ends-with-sub-string)
|
||||||
|
* [FILES](#files)
|
||||||
|
* [Get the first N lines of a file](#get-the-first-n-lines-of-a-file)
|
||||||
|
|
||||||
<!-- vim-markdown-toc -->
|
<!-- vim-markdown-toc -->
|
||||||
|
|
||||||
@@ -145,3 +147,33 @@ case $var in
|
|||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
```
|
```
|
||||||
|
|
||||||
|
# FILES
|
||||||
|
|
||||||
|
## Get the first N lines of a file
|
||||||
|
|
||||||
|
Alternative to the `head` command.
|
||||||
|
|
||||||
|
**Example Function:**
|
||||||
|
|
||||||
|
```sh
|
||||||
|
head() {
|
||||||
|
# Usage: head "n" "file"
|
||||||
|
while read -r line; do
|
||||||
|
[ "$i" = "$1" ] && break
|
||||||
|
printf '%s\n' "$line"
|
||||||
|
i=$((i+1))
|
||||||
|
done < "$2"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example Usage:**
|
||||||
|
|
||||||
|
```shell
|
||||||
|
$ head 2 ~/.bashrc
|
||||||
|
# Prompt
|
||||||
|
PS1='➜ '
|
||||||
|
|
||||||
|
$ head 1 ~/.bashrc
|
||||||
|
# Prompt
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user