<commit_before>**Thanks for downloading Corgi Scripts (v2016.12.04)!**

Corgi Scripts is a library of executable shell scripts, reusable shell functions, and Openbox pipemenus.  
It is authored with a focus on portability, reusability, and POSIX compliance.  
Library functions are both semantic and well-documented.  
Both the library functions and the Openbox menus generated from them are *highly performant, even with large sets of data*.

Executables are located under *bin*  
Library functions (sourced and used by the executables) are located under *lib*  
Static resources, such as icons, are located under *share*  

Screenshots of current Openbox pipemenus can be found under **[SCREENSHOTS/openbox](SCREENSHOTS/openbox)**

A summary of packages used by the library is at the bottom of this doc.  
If you want have a look, before getting started, skip to **[Required Packages](#required-packages)**

Quick install instructions are below this greeting.


**Quick Install**  

You can run the executables directly from the downloaded, expanded package, or,  
from within the corgi-scripts directory, call the installer script  
(installs to /usr/local, by default, overriden by adding `--prefix=`):

```
# ./install.sh
```

Currently, most executables in the Corgi library don't require root permissions to run.
You may simply call them directly, or, in the case of Openbox pipmenu executables, add them to your menu.xml file, like so:

```
<menu id="network" label="Network" execute="corgi-openbox-menus-networkmanager" />
<menu id="network" label="Samba" execute="corgi-openbox-menus-samba" />
```

Currently, there are two executables which require root permissions:

`corgi-display-brightness-control`
`corgi-openbox-menus-power-management` (permissions required ONLY if you need to get/set cpu performance bias)

As Openbox does not prompt for a password when rendering menus,  
and `corgi-openbox-menus-power-management` is responsible for generating a pipemenu,  
you will want to add it to your user's NOPASSWD list via visudo, like so:

```
# visudo

<USERNAME> ALL=(ALL) NOPASSWD: /usr/local/bin/corgi-openbox-menus-power-management
```

Then, prefix sudo to the execute attribute of the pipemenu's menu element in menu.xml, like so:

```
<menu id="system-power-management" label="Power Mgmt" execute="sudo corgi-openbox-menus-power-management" />
```

Additionally, you can add calls for executables to your ACPI handler script (/etc/acpi/handler.sh), like so:

```
case "$1" in<commit_msg>documentation fix<commit_after>**Thanks for downloading Corgi Scripts (v2016.12.04)!**

Corgi Scripts is a library of executable shell scripts, reusable shell functions, and Openbox pipemenus.  
It is authored with a focus on portability, reusability, and POSIX compliance.  
Library functions are both semantic and well-documented.  
Both the library functions and the Openbox menus generated from them are *highly performant, even with large sets of data*.

Executables are located under *bin*  
Library functions (sourced and used by the executables) are located under *lib*  
Static resources, such as icons, are located under *share*  

Screenshots of current Openbox pipemenus can be found under **[SCREENSHOTS/openbox](SCREENSHOTS/openbox)**

A summary of packages used by the library is at the bottom of this doc.  
If you want have a look, before getting started, skip to **[Required Packages](#required-packages)**

Quick install instructions are below this greeting.


**Quick Install**  

You can run the executables directly from the downloaded, expanded package, or,  
from within the corgi-scripts directory, call the installer script  
(installs to /usr/local, by default, overriden by adding `--prefix=`):

```
# ./install.sh
```

Currently, most executables in the Corgi library don't require root permissions to run.
You may simply call them directly, or, in the case of Openbox pipmenu executables, add them to your menu.xml file, like so:

```
<menu id="network" label="Network" execute="corgi-openbox-menus-networkmanager" />
<menu id="samba" label="Samba" execute="corgi-openbox-menus-samba" />
```

Currently, there are two executables which require root permissions:

`corgi-display-brightness-control`
`corgi-openbox-menus-power-management` (permissions required ONLY if you need to get/set cpu performance bias)

As Openbox does not prompt for a password when rendering menus,  
and `corgi-openbox-menus-power-management` is responsible for generating a pipemenu,  
you will want to add it to your user's NOPASSWD list via visudo, like so:

```
# visudo

<USERNAME> ALL=(ALL) NOPASSWD: /usr/local/bin/corgi-openbox-menus-power-management
```

Then, prefix sudo to the execute attribute of the pipemenu's menu element in menu.xml, like so:

```
<menu id="system-power-management" label="Power Mgmt" execute="sudo corgi-openbox-menus-power-management" />
```

Additionally, you can add calls for executables to your ACPI handler script (/etc/acpi/handler.sh), like so:

```
case "$1" in
{'fraction_non_alphanumeric': 0.0900398406374502, 'fraction_numerical': 0.0035856573705179283, 'mean_word_length': 4.865654205607477, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 4}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '35440', 'n_tokens_mistral': 1522, 'n_tokens_neox': 1428, 'n_words': 616}