diff options
author | Louie Lu <git@louie.lu> | 2019-05-31 20:53:39 +0200 |
---|---|---|
committer | Christian Persch <chpe@src.gnome.org> | 2019-05-31 20:53:39 +0200 |
commit | dc94f74c766fd445710d54946093040282bd80d3 (patch) | |
tree | 704e2c2efadc9bfb407aa2d57cf47b469bcca961 /README.md | |
parent | e5b017af473503f74724cb3210846575900fa486 (diff) | |
download | vte-dc94f74c766fd445710d54946093040282bd80d3.tar.gz |
all: Add installation & debugging information
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..74792848 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +Virtual TErminal +================ + +VTE provides a virtual terminal widget for GTK applications. + +Installation +------------ + +``` +$ git clone https://gitlab.gnome.org/GNOME/vte # Get the source code of VTE +$ cd vte # Change to the toplevel directory +$ meson _build # Run the configure script +$ ninja -C _build # Build VTE +[ Optional ] +$ ninja -C _build install # Install VTE to default `/usr/local` +``` + +* By default, VTE will install under `/usr/local`. You can customize the +prefix directory by `--prefix` option, e.g. If you want to install VTE under +`~/foobar`, you should run `meson _build --prefix=~/foobar`. If you already +run the configure script before, you should also pass `--reconfigure` option to it. + +* You may need to execute `ninja -C _build install` as root +(i.e. `sudo ninja -C _build install`) if installing to system directories. + +* If you wish to test VTE before installing it, you may execute it directly from +its build directory. As `_build` directory, it should be `_build/src/app/vte-[version]`. + +* You can pass `-Ddebugg=true` option to meson if you wish to enable debug function. + + +Debugging +--------- + +After installing VTE with `-Ddebugg=true` flag, you can use `VTE_DEBUG` variable to control +VTE to print out the debug information + +``` +# You should change vte-[2.91] to the version you build +$ VTE_DEBUG=selection ./_build/src/app/vte-2.91 + +# Or, you can mixup with multiple logging level +$ VTE_DEBUG=selection,draw,cell ./_build/src/app/vte-2.91 + +$ Or, you can use `all` to print out all logging message +$ VTE_DEBUG=all ./_build/src/app/vte-2.91 +``` + +For logging level information, please refer to enum [VteDebugFlags](src/debug.h). + + +Contributing +------------ + +Bugs should be filed here: https://gitlab.gnome.org/GNOME/vte/issues/ +Please note that this is *not a support forum*; if you are a end user, +always file bugs in your distribution's bug tracker, or use their +support forums. + +If you want to provide a patch, please attach them to an issue in GNOME +GitLab, in the format output by the git format-patch command. |