| 1 | # libslirp
|
|---|
| 2 |
|
|---|
| 3 | libslirp is a user-mode networking library used by virtual machines,
|
|---|
| 4 | containers or various tools.
|
|---|
| 5 |
|
|---|
| 6 | ## Getting Started
|
|---|
| 7 |
|
|---|
| 8 | ### Prerequisites
|
|---|
| 9 |
|
|---|
| 10 | A C compiler, meson and glib2 development libraries.
|
|---|
| 11 |
|
|---|
| 12 | (see also [.gitlab-ci.yml](.gitlab-ci.yml) DEPS variable for the list
|
|---|
| 13 | of dependencies on Fedora)
|
|---|
| 14 |
|
|---|
| 15 | ### Building
|
|---|
| 16 |
|
|---|
| 17 | You may build and install the shared library with meson:
|
|---|
| 18 |
|
|---|
| 19 | ``` sh
|
|---|
| 20 | meson build
|
|---|
| 21 | ninja -C build install
|
|---|
| 22 | ```
|
|---|
| 23 | And configure QEMU with --enable-slirp=system to link against it.
|
|---|
| 24 |
|
|---|
| 25 | (QEMU may build with the submodule static library using --enable-slirp=git)
|
|---|
| 26 |
|
|---|
| 27 | ### Testing
|
|---|
| 28 |
|
|---|
| 29 | Unfortunately, there are no automated tests available.
|
|---|
| 30 |
|
|---|
| 31 | You may run QEMU ``-net user`` linked with your development version.
|
|---|
| 32 |
|
|---|
| 33 | ## Contributing
|
|---|
| 34 |
|
|---|
| 35 | Feel free to open issues on the [project
|
|---|
| 36 | issues](https://gitlab.freedesktop.org/slirp/libslirp/issues) page.
|
|---|
| 37 |
|
|---|
| 38 | You may clone the [gitlab
|
|---|
| 39 | project](https://gitlab.freedesktop.org/slirp/libslirp) and create a
|
|---|
| 40 | merge request.
|
|---|
| 41 |
|
|---|
| 42 | Contributing with gitlab allows gitlab workflow, tracking issues,
|
|---|
| 43 | running CI etc.
|
|---|
| 44 |
|
|---|
| 45 | Alternatively, you may send patches to slirp@lists.freedesktop.org
|
|---|
| 46 | mailing list.
|
|---|
| 47 |
|
|---|
| 48 | ## Versioning
|
|---|
| 49 |
|
|---|
| 50 | We intend to use [libtool's
|
|---|
| 51 | versioning](https://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html)
|
|---|
| 52 | for the shared libraries and use [SemVer](http://semver.org/) for
|
|---|
| 53 | project versions.
|
|---|
| 54 |
|
|---|
| 55 | For the versions available, see the [tags on this
|
|---|
| 56 | repository](https://gitlab.freedesktop.org/slirp/libslirp/releases).
|
|---|
| 57 |
|
|---|
| 58 | ## License
|
|---|
| 59 |
|
|---|
| 60 | See the [COPYRIGHT](COPYRIGHT) file for details.
|
|---|
