BlueGit

timfa posprint

Files

posprint / docs / BUILD.md

BUILD.md

BUILD.md 3.7 KiB Download Raw

Build scripts

Local release builds for Windows and Linux.

Toolchain

You need a Rust toolchain (1.88+; CI uses 1.96). Install once:

# Recommended (any distro)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# then restart the shell, or: source "$HOME/.cargo/env"

# Or on Arch Linux
sudo pacman -S --needed rust

Also install the platform build libraries under Linux build dependencies below before cargo test / cargo build.

Windows

.\scripts\build-windows.ps1

Output: target\release\posprint.exe

Options:

.\scripts\build-windows.ps1 -Deb:$false   # exe only (default)

Linux

chmod +x scripts/build-linux.sh
./scripts/build-linux.sh                # release binary
./scripts/build-linux.sh --deb          # binary + .deb (prompts to install if interactive)
./scripts/build-linux.sh --deb --install  # build .deb and install with apt

On Arch Linux:

chmod +x scripts/build-arch.sh
./scripts/build-arch.sh                 # .pkg.tar.zst (prompts to install if interactive)
./scripts/build-arch.sh --install      # build and install with pacman

build-arch.sh accepts a rustup toolchain on PATH. If the pacman rust/cargo packages are not installed, it runs makepkg --nodeps after verifying rustc/cargo work (the PKGBUILD still lists those packages for AUR/CI).

After a successful package build, both scripts ask whether to install (TTY only). Pass --install to skip the prompt and install automatically. Non-interactive runs (CI/pipes) never prompt.

Outputs:

ArtifactPath
Binarytarget/release/posprint
Debian packagetarget/debian/*.deb
Arch packagepackaging/arch/posprint-*-x86_64.pkg.tar.zst

Linux targets we support

FormatDistrosNotes
.debDebian, Ubuntu, Mint, Pop!_OS, etc.Recommended for apt-based systems; produced by cargo-deb
.pkg.tar.zstArch Linux, Manjaro, EndeavourOS, etc.Recommended for pacman; sudo pacman -U posprint-*.pkg.tar.zst
Raw binaryAny x86_64 LinuxCopy target/release/posprint; needs X11/Wayland libs at runtime
.rpmFedora, RHEL, openSUSENot automated yet; build binary and wrap with fpm if needed
AppImageUniversalNot automated yet; good for portable distribution

Architecture: x86_64 (amd64) only in CI and build scripts today.

Linux build dependencies (Debian/Ubuntu)

sudo apt-get install -y build-essential pkg-config \
  libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev \
  libssl-dev libudev-dev

For .deb:

cargo install cargo-deb --locked

Arch Linux build dependencies

sudo pacman -S --needed base-devel rust pkgconf openssl libxkbcommon libxcb dbus \
  wayland libx11 fontconfig freetype2 libglvnd git rsync

File association (.pos → posprint)

The package installs:

  • /usr/share/mime/packages/posprint.xml → MIME type application/x-posprint for *.pos
  • /usr/share/applications/posprint.desktop → claims that MIME type

After pacman -U, pacman hooks refresh the MIME and desktop databases. To make posprint the default opener (double-click):

xdg-mime default posprint.desktop application/x-posprint
xdg-mime query filetype some.pos          # expect: application/x-posprint
xdg-mime query default application/x-posprint  # expect: posprint.desktop

If query filetype still says text/plain, the MIME package was not installed or the cache is stale:

sudo update-mime-database /usr/share/mime
sudo update-desktop-database /usr/share/applications

Tests before release

cargo test --release
Source
1# Build scripts
2
3Local release builds for Windows and Linux.
4
5## Toolchain
6
7You need a Rust toolchain (**1.88+**; CI uses 1.96). Install once:
8
9```bash
10# Recommended (any distro)
11curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
12# then restart the shell, or: source "$HOME/.cargo/env"
13
14# Or on Arch Linux
15sudo pacman -S --needed rust
16```
17
18Also install the platform build libraries under **Linux build dependencies** below before `cargo test` / `cargo build`.
19
20## Windows
21
22```powershell
23.\scripts\build-windows.ps1
24```
25
26Output: `target\release\posprint.exe`
27
28Options:
29
30```powershell
31.\scripts\build-windows.ps1 -Deb:$false # exe only (default)
32```
33
34## Linux
35
36```bash
37chmod +x scripts/build-linux.sh
38./scripts/build-linux.sh # release binary
39./scripts/build-linux.sh --deb # binary + .deb (prompts to install if interactive)
40./scripts/build-linux.sh --deb --install # build .deb and install with apt
41```
42
43On **Arch Linux**:
44
45```bash
46chmod +x scripts/build-arch.sh
47./scripts/build-arch.sh # .pkg.tar.zst (prompts to install if interactive)
48./scripts/build-arch.sh --install # build and install with pacman
49```
50
51`build-arch.sh` accepts a **rustup** toolchain on `PATH`. If the pacman `rust`/`cargo` packages are not installed, it runs `makepkg --nodeps` after verifying `rustc`/`cargo` work (the PKGBUILD still lists those packages for AUR/CI).
52
53After a successful package build, both scripts ask whether to install (TTY only). Pass `--install` to skip the prompt and install automatically. Non-interactive runs (CI/pipes) never prompt.
54
55Outputs:
56
57| Artifact | Path |
58|----------|------|
59| Binary | `target/release/posprint` |
60| Debian package | `target/debian/*.deb` |
61| Arch package | `packaging/arch/posprint-*-x86_64.pkg.tar.zst` |
62
63### Linux targets we support
64
65| Format | Distros | Notes |
66|--------|---------|-------|
67| **`.deb`** | Debian, Ubuntu, Mint, Pop!_OS, etc. | **Recommended** for apt-based systems; produced by `cargo-deb` |
68| **`.pkg.tar.zst`** | Arch Linux, Manjaro, EndeavourOS, etc. | **Recommended** for pacman; `sudo pacman -U posprint-*.pkg.tar.zst` |
69| **Raw binary** | Any x86_64 Linux | Copy `target/release/posprint`; needs X11/Wayland libs at runtime |
70| **`.rpm`** | Fedora, RHEL, openSUSE | Not automated yet; build binary and wrap with `fpm` if needed |
71| **AppImage** | Universal | Not automated yet; good for portable distribution |
72
73**Architecture:** `x86_64` (amd64) only in CI and build scripts today.
74
75### Linux build dependencies (Debian/Ubuntu)
76
77```bash
78sudo apt-get install -y build-essential pkg-config \
79 libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev \
80 libssl-dev libudev-dev
81```
82
83For `.deb`:
84
85```bash
86cargo install cargo-deb --locked
87```
88
89### Arch Linux build dependencies
90
91```bash
92sudo pacman -S --needed base-devel rust pkgconf openssl libxkbcommon libxcb dbus \
93 wayland libx11 fontconfig freetype2 libglvnd git rsync
94```
95
96### File association (`.pos` → posprint)
97
98The package installs:
99
100- `/usr/share/mime/packages/posprint.xml` → MIME type `application/x-posprint` for `*.pos`
101- `/usr/share/applications/posprint.desktop` → claims that MIME type
102
103After `pacman -U`, pacman hooks refresh the MIME and desktop databases. To make posprint the **default** opener (double-click):
104
105```bash
106xdg-mime default posprint.desktop application/x-posprint
107xdg-mime query filetype some.pos # expect: application/x-posprint
108xdg-mime query default application/x-posprint # expect: posprint.desktop
109```
110
111If `query filetype` still says `text/plain`, the MIME package was not installed or the cache is stale:
112
113```bash
114sudo update-mime-database /usr/share/mime
115sudo update-desktop-database /usr/share/applications
116```
117
118## Tests before release
119
120```bash
121cargo test --release
122```