From 63db1b42b09225724fabcddae35b6b8383bb7e59 Mon Sep 17 00:00:00 2001 From: fechin Date: Fri, 30 Dec 2022 13:57:32 +0800 Subject: [PATCH] Added INI --- source/_posts/ini.md | 191 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 191 insertions(+) create mode 100644 source/_posts/ini.md diff --git a/source/_posts/ini.md b/source/_posts/ini.md new file mode 100644 index 0000000..b2bf746 --- /dev/null +++ b/source/_posts/ini.md @@ -0,0 +1,191 @@ +--- +title: INI +date: 2022-12-30 09:51:44 +background: bg-[#6d94c7] +tags: +categories: + - Programming +intro: | + This is a quick reference cheat sheet for understanding and writing INI-format configuration files. +--- + +Getting Started +---- + + + +### introduction + +- INI is a configuration file with a fixed standard format +- Base elements are keys or properties +- Each key consists of a `name` and a `value`, separated by an equal sign (`=`) +- `key name` is displayed to the `left side` of the equals sign +- `equal sign` and `semicolon` are `reserved` characters +- INI configuration method comes from the MS-DOS operating system + +Now an informal standard for many configurations, other operating systems may use `.conf` or `.cfg` as a suffix + + +### Example + + +```ini +; Here are the comments +[owner] +name=John Doe +organization=Acme Products + +[database] +; Here are the comments +server=192.0.2.42 +port=143 +file="acme payroll.dat" +``` + + + + +### Comments + +comment (`;`) + +```ini +; This is the comment text and will be ignored +``` + +comment (`#`) +```ini +# Here is the comment text, ⚠️ Some compilers support it +``` + +Comments after a line (`;`,`#`) _(not standard)_ + +```ini +var = a ; this is an inline comment +foo = bar # this is another inline comment +``` + +Comments must appear alone on lines in some cases + + + +### Sections + +- The name appears on a line by itself +- Names are enclosed in square brackets `[` and `]` +- No explicit `section end` delimiter +- End at the next `section` declaration or at the end of the file +- Section and attribute names are case insensitive + + +```ini +[section] +key1 = a +key2 = b +``` + +The same as `JSON` below 👇 + +```json +{ + "section": { + "key1": "a", + "key2": "b" + } +} +``` + + + +### Nesting (supported by some parsers) + +```ini +[section] +domain = jaywcjlove.github.io +[section.subsection] +foo = bar +``` + +The same as `JSON` below 👇 + +```js +{ + "section": { + "domain": "jaywcjlove.github.io" + "subsection": { + "foo": "bar" + } + } +} +``` + +Nest to previous section (shorthand) + +```ini +[section] +domain = jaywcjlove.github.io +[.subsection] +foo = bar +``` + + + +### escape character + +sequence | meaning +:-| :- +`\\` | \ (single backslash, escape escape character) +`\'` | apostrophe +`\"` | double quotes +`\0` | null character +`\a` | ringtone/alert/sound +`\b` | Backspace, [Bell character] for some applications (https://en.wikipedia.org/wiki/Bell_character) +`\t` | tab character +`\r` | carriage return +`\n` | newline +`\;` | semicolon +`\#` | number sign +`\=` | equal sign +`\:` | colon +`\x????` | Unicode character for the hexadecimal code point corresponding to ???? + + + +### array + +```ini +[section] +domain = jaywcjlove.github.io +array[]=first value +array[]=second value +``` + +The same as `JSON` below 👇 + +```js +{ + "section": { + "domain": "jaywcjlove.github.io", + "array": [ + "first value", "second value" + ] + } +} +``` + + + +### Interpreter + +- [@go-ini/ini](https://github.com/go-ini/ini) _(golang)_ +- [@npm/ini](https://www.npmjs.com/package/ini) _(nodejs)_ +- [@zonyitoo/rust-ini](https://github.com/zonyitoo/rust-inii) _(rust)_ +- [@rxi/ini](https://www.npmjs.com/package/ini) _(c)_ +- [@pulzed/mINI](https://github.com/pulzed/mINI) _(c++)_ +- [@rickyah/ini-parser](https://github.com/rickyah/ini-parser) _(c#)_ +- [@Enichan/Ini](https://github.com/Enichan/Ini) _(c#)_ + + +See also +--- +- [INI file configuration](https://en.wikipedia.org/wiki/INI_file)_(wikipedia.org)_ \ No newline at end of file