template-bash/README.md

# template-bash
Template repository for projects on bash

* [`script.sh`](https://git.hmp.today/pavel.muhortov/template-bash#script-sh)

____
## `script.sh`
**Description:**  
> returning current username if privileged rights are exist  
> or  
> returning error, if privileged rights are not exist


**Dependencies:**  
> - bash (tested version 5.1.4 on Debian GNU/Linux 11)


|  POSITION | PARAMETERS   |       DESCRIPTION      |    DEFAULT    |
|-----------|--------------|------------------------|---------------|
|     1     |    **[qn]**    |execution without pauses||
|     2     |    **[/path/to/conf]**    |path to config|     ./script.conf    |


Example usage in terminal with bash:
```shell
bash ./script.sh qn ./script.conf
```
Example usage in terminal with make the script executable:
```shell
chmod u+x ./script.sh
script.sh
```