diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 97 |
1 files changed, 66 insertions, 31 deletions
| @@ -1,55 +1,90 @@ | |||
| 1 | # libplist | 1 | # libplist |
| 2 | 2 | ||
| 3 | ## About | 3 | *A small portable C library to handle Apple Property List files in binary or XML |
| 4 | format.* | ||
| 4 | 5 | ||
| 5 | A small portable C library to handle Apple Property List files in binary or XML. | 6 | ## Features |
| 6 | 7 | ||
| 7 | ## Requirements | 8 | The project provides an interface to read and write plist files in binary or |
| 9 | XML format alongside a command-line utility named `plistutil`. | ||
| 8 | 10 | ||
| 9 | Software: | 11 | - **Formats:** Supports binary and XML format |
| 10 | * make | 12 | - **Utility:** Provides a `plistutil` utility for the command-line |
| 11 | * autoheader | 13 | - **Python:** Provides Cython based bindings for Python |
| 12 | * automake | 14 | - **Tested:** Uses fuzzing and data compliance tests |
| 13 | * autoconf | 15 | - **Efficient:** Lean library with performance and resources in mind |
| 14 | * libtool | ||
| 15 | * pkg-config | ||
| 16 | * gcc or clang | ||
| 17 | 16 | ||
| 18 | Optional: | 17 | ## Installation / Getting started |
| 19 | * cython (Python bindings) | ||
| 20 | * doxygen (Documentation) | ||
| 21 | 18 | ||
| 22 | ## Installation | 19 | ### Debian / Ubuntu Linux |
| 23 | 20 | ||
| 24 | To compile run: | 21 | First install all required dependencies and build tools: |
| 25 | ```bash | 22 | ```shell |
| 23 | sudo apt-get install \ | ||
| 24 | build-essential \ | ||
| 25 | checkinstall \ | ||
| 26 | git \ | ||
| 27 | autoconf \ | ||
| 28 | automake \ | ||
| 29 | libtool-bin | ||
| 30 | ``` | ||
| 31 | |||
| 32 | If you want to optionally build the documentation or Python bindings use: | ||
| 33 | ```shell | ||
| 34 | sudo apt-get install \ | ||
| 35 | doxygen \ | ||
| 36 | cython | ||
| 37 | ``` | ||
| 38 | |||
| 39 | Then clone the actual project repository: | ||
| 40 | ```shell | ||
| 41 | git clone https://github.com/libimobiledevice/libplist.git | ||
| 42 | cd libplist | ||
| 43 | ``` | ||
| 44 | |||
| 45 | Now you can build and install it: | ||
| 46 | ```shell | ||
| 26 | ./autogen.sh | 47 | ./autogen.sh |
| 27 | make | 48 | make |
| 28 | sudo make install | 49 | sudo make install |
| 29 | ``` | 50 | ``` |
| 30 | 51 | ||
| 31 | If you require a custom prefix or other option being passed to `./configure` | 52 | ## Usage |
| 32 | you can pass them directly to `./autogen.sh` like this: | 53 | |
| 33 | ```bash | 54 | Then simply run: |
| 34 | ./autogen.sh --prefix=/opt/local --without-cython | 55 | ```shell |
| 35 | make | 56 | plistutil -i foobar.plist -o output.plist |
| 36 | sudo make install | ||
| 37 | ``` | 57 | ``` |
| 38 | 58 | ||
| 39 | ## Who/What/Where? | 59 | This converts the `foobar.plist` file to the opposite format, e.g. binary to |
| 60 | XML or vice versa, and outputs it to the `output.plist` file. | ||
| 61 | |||
| 62 | Please consult the usage information or manual page for a full documentation of | ||
| 63 | available command line options: | ||
| 64 | ```shell | ||
| 65 | plistutil --help | ||
| 66 | man plistutil | ||
| 67 | ``` | ||
| 40 | 68 | ||
| 41 | * Home: https://libimobiledevice.org/ | 69 | ## Links |
| 42 | * Code: `git clone https://git.libimobiledevice.org/libplist.git` | 70 | |
| 43 | * Code (Mirror): `git clone https://github.com/libimobiledevice/libplist.git` | 71 | * Homepage: https://libimobiledevice.org/ |
| 44 | * Tickets: https://github.com/libimobiledevice/libplist/issues | 72 | * Repository: https://git.libimobiledevice.org/libplist.git |
| 73 | * Repository (Mirror): https://github.com/libimobiledevice/libplist.git | ||
| 74 | * Issue Tracker: https://github.com/libimobiledevice/libplist/issues | ||
| 45 | * Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel | 75 | * Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel |
| 46 | * Twitter: https://twitter.com/libimobiledev | 76 | * Twitter: https://twitter.com/libimobiledev |
| 47 | 77 | ||
| 78 | ## License | ||
| 79 | |||
| 80 | This project is licensed under the [GNU Lesser General Public License v2.1](https://www.gnu.org/licenses/lgpl-2.1.en.html), | ||
| 81 | also included in the repository in the `COPYING` file. | ||
| 82 | |||
| 48 | ## Credits | 83 | ## Credits |
| 49 | 84 | ||
| 50 | Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc. | 85 | Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc. |
| 51 | 86 | ||
| 52 | libplist is an independent software library and has not been | 87 | This project is an independent software library and has not been authorized, |
| 53 | authorized, sponsored, or otherwise approved by Apple Inc. | 88 | sponsored, or otherwise approved by Apple Inc. |
| 54 | 89 | ||
| 55 | README Updated on: 2020-06-08 | 90 | README Updated on: 2020-06-12 |
