https://github.com/iron-wolf/script
Script and stuff
https://github.com/iron-wolf/script
perl-script personal powershell-script script shell-script
Last synced: 9 months ago
JSON representation
Script and stuff
- Host: GitHub
- URL: https://github.com/iron-wolf/script
- Owner: Iron-Wolf
- Created: 2016-08-14T15:32:41.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-15T20:50:58.000Z (about 1 year ago)
- Last Synced: 2024-11-15T21:29:40.693Z (about 1 year ago)
- Topics: perl-script, personal, powershell-script, script, shell-script
- Language: GLSL
- Homepage:
- Size: 215 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Table of contents
- [Description](#description)
- [Markdown Documentation](#markdown-documentation)
- [Writting Conventions](#writting-conventions)
# Description
Contains scripts and notes on various software (games, tools, linux, ...).
Serves as a back-up and centralization for all my tuning/tweaking needs.
# Markdown Documentation
I don't know where to put this, so here it is.
## Highlighting box
Highlights a text by framing it in an element with an icon.
Useful for writing a Wiki.
This was inspired by some cool documentation, like [Spring Boot](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.devtools).
> [âšī¸](# "Note") Note
> Add details or a context to something
> [â
](# "Tips") Tips
> Add another way of doing things or give details on how to use.
> This box can be expanded with several lines.
> [đ](# "Important") Important
> Extra warning to prevent major issues
> [â ī¸](# "Warning") Warning
> Warns or prevent potential consequences
> [âī¸](# "Caution") Caution
> Indicate that something is impossible or not advised
To add this box, you can use this notation :
```markdown
current page
add anchor ââââââ â âââââââ tooltip
> [âšī¸](# "Info")
> Text here
```
## Highlight in GitHub
> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
# Writting Conventions
## Command/code synopsis
### Description
Convention used to describe command usage or code snippets.
Usefull for text friendly manual or usage tips in documentations.
| Usage | [Manual (Unix)](https://man7.org/linux/man-pages/man1/man.1.html#DESCRIPTION) | [PostgreSQL](https://www.postgresql.org/docs/current/notation.html) | regex
|---|---|---|---|
| used for as-is text | **bold** format (no format in cli) | no format | |
| indicate replaceable arguments | _italic_ format (underlined uppercase in cli) | _**italic and bold**_ | `\w+` |
| choices delimiter | not supported (braces `{}` in GNU style) | braces `{}` | `()` |
| choices separator | vertical bars `\|` | vertical bars `\|` | `\|` |
| surround optional parts or arguments | brackets `[]` | brackets `[]` | `()?` |
| the preceding element can be repeated | ellipses `...` | ellipses `...` | `( \g<-2>)*` |
All other symbols, including parentheses, should be taken literally
### Exemple
> **ftp** [-**pinegvd**] [_host_]
> `ftp (-[pinegvd]+)?( \g<-2>)* [a-zA-Z0-9_.]+`
- ftp -p sample.host
- ftp -i other.host
> GRANT { { CREATE | CONNECT | TEMPORARY | TEMP } [, ...] | ALL [ PRIVILEGES ] } ON DATABASE database_name [, ...] TO role_specification [, ...] [ WITH GRANT OPTION ][ GRANTED BY role_specification ]
> `GRANT (((CREATE|CONNECT|TEMPORARY|TEMP)(,\g<2>)*)|(ALL( PRIVILEGES)?)) ON DATABASE (\w+)(,\g<-2>)* TO (\w+)(,\g<-2>)*( WITH GRANT OPTION)?( GRANTED BY (\w+)(,\g<-2>)*)?`
- GRANT CREATE, CONNECT ON DATABASE db-sample TO db-user
- GRANT ALL ON DATABASE db-sample TO db-user