diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 14 insertions, 7 deletions
| @@ -1,18 +1,18 @@ | |||
| 1 | # libplist | 1 | # libplist |
| 2 | 2 | ||
| 3 | *A small portable C library to handle Apple Property List files in binary or XML | 3 | *A small portable C library to handle Apple Property List files in binary, XML, |
| 4 | format.* | 4 | JSON, or OpenStep format.* |
| 5 | 5 | ||
| 6 |  | 6 |  |
| 7 | 7 | ||
| 8 | ## Features | 8 | ## Features |
| 9 | 9 | ||
| 10 | The project provides an interface to read and write plist files in binary or | 10 | The project provides an interface to read and write plist files in binary, |
| 11 | XML format alongside a command-line utility named `plistutil`. | 11 | XML, JSON, or OpenStep format alongside a command-line utility named `plistutil`. |
| 12 | 12 | ||
| 13 | Some key features are: | 13 | Some key features are: |
| 14 | 14 | ||
| 15 | - **Formats:** Supports binary and XML format | 15 | - **Formats:** Supports binary, XML, JSON, and OpenStep format |
| 16 | - **Utility:** Provides a `plistutil` utility for the command-line | 16 | - **Utility:** Provides a `plistutil` utility for the command-line |
| 17 | - **Python:** Provides Cython based bindings for Python | 17 | - **Python:** Provides Cython based bindings for Python |
| 18 | - **Tested:** Uses fuzzing and data compliance tests | 18 | - **Tested:** Uses fuzzing and data compliance tests |
| @@ -59,10 +59,17 @@ Then simply run: | |||
| 59 | ```shell | 59 | ```shell |
| 60 | plistutil -i foobar.plist -o output.plist | 60 | plistutil -i foobar.plist -o output.plist |
| 61 | ``` | 61 | ``` |
| 62 | |||
| 63 | This converts the `foobar.plist` file to the opposite format, e.g. binary to | 62 | This converts the `foobar.plist` file to the opposite format, e.g. binary to |
| 64 | XML or vice versa, and outputs it to the `output.plist` file. | 63 | XML or vice versa, and outputs it to the `output.plist` file. |
| 65 | 64 | ||
| 65 | To convert to a specific format - and also to convert from JSON or OpenStep | ||
| 66 | format - use the `-f` command line switch: | ||
| 67 | ```shell | ||
| 68 | plistutil -i input.plist -f json | ||
| 69 | ``` | ||
| 70 | This will convert input.plist, regardless of the input format, to JSON. The | ||
| 71 | code auto-detects the input format and parses it accordingly. | ||
| 72 | |||
| 66 | Please consult the usage information or manual page for a full documentation of | 73 | Please consult the usage information or manual page for a full documentation of |
| 67 | available command line options: | 74 | available command line options: |
| 68 | ```shell | 75 | ```shell |
| @@ -111,4 +118,4 @@ iPadOS, tvOS, watchOS, and macOS are trademarks of Apple Inc. | |||
| 111 | This project is an independent software library and has not been authorized, | 118 | This project is an independent software library and has not been authorized, |
| 112 | sponsored, or otherwise approved by Apple Inc. | 119 | sponsored, or otherwise approved by Apple Inc. |
| 113 | 120 | ||
| 114 | README Updated on: 2020-06-12 | 121 | README Updated on: 2023-01-08 |
