Nanolx
=======================================

About
=======================================

Nanolx is a set of meta-packages, wich I use to aid in syncing the package
selection between my machine and machines that are maintained by me.

They can be safely used by anyone on Debian GNU/Linux as they won't remove
or change existing packages. As of version 4.2 no configuration changes to
/etc are done automatically, configuration is stored in /usr/share/nanolx/
and you can use the provided scripts (see below) to adjust as you like.

Addtionally Nanolx contains the default set of themes I prefer to use, see
the nanolx-themes package below

On Debian-based distributions you'll likely not be able to meet all dependecies
of the packages. In that case

    make install

would only install the included scripts (see below), configuration and themes.

If you only want to update the configuration for the following scripts:
    - hugo-push
    - repokit
    - nanolx-apt
    - nanolx-orbit

use

   make update-conf

On non Debian-based distributions you'll only be able to use the scripts:
    - hugo-push
    - nanolx-backup (if systemd is in use)
    - nanolx-ctx
    - nanolx-pam-yubikey
    - nanolx-refind

copy/install them manually if desired.

Release Information
=======================================

see debian/changelog for changes

Version:    4.11.0
Release:    20260804

Installation on Debian GNU/Linux
=======================================

Get the signing key for my repository, located at:
    https://www.nanolx.org/apt/photonic2026.asc

and save it as:
    /etc/apt/trusted.gpg.d/nanolx2026.asc

create:
    /etc/apt/sources.list.d/nanolx.sources

with the following content:
    Types: deb deb-src
    URIs: https://apt.nanolx.org/
    Suites: photonic
    Components: main
    Signed-By: /etc/apt/trusted.gpg.d/nanolx2026.asc

then proceed to install. Install either

- nanolx-base + selected individual packages
    - nanolx-base only requires nanolx-apt-sources and nanolx-apt-tools
- nanolx-full for all packages except nanolx-citrix-config
    - nanolx-full is new with nanolx-4.11.0

License
=======================================

nanolx itself is licensed under the GNU GPL v3 (or newer). Individual files,
like plymouth / rEFInd themes, differ in licensing. For a full overview consult

    debian/copyright

Packages
=======================================

consult debian/control for full description and pulled packages.

nanolx-full:
    new with nanolx-4.11.0, pulls all packages below, except nanolx-citrix-config

nanolx-base:
    as of nanolx-4.11.0: base-package pulling nanolx-apt-sources and nanolx-apt-tools
    before nanolx-4.11.0: base-package pulling all packages below, except nanolx-themes
    and nanolx-citrix-config

nanolx-admin:
    pulls cli and gui tools for system administration,
    e.g.: gkdebconf, localepurge, packagesearch, cruft-ng and more

nanolx-apt-sources:
    provides additional, curated, apt repositories - which are not enabled by
    default, see the    nanolx-apt    script below.

nanolx-apt-tools:
    pulls nanolx-apt-sources and additional tools regarding apt, like gdebi,
    reprepro, debdelta.

nanolx-cli:
    pulls a collection of command line utilities, like rsync, mc, unp, plocate,
    bashstyle-ng and more.

nanolx-x11:
    pulls a small collection of ui tools, like psensor, conky, libgtk-nocsd0
    and KDE/Plasma.

nanolx-security:
    pulls a collection of security related tools, like psad, lynis, rkhunter,
    clamav, also Yubikey tools.

nanolx-net:
    pulls a collection of networking and connectivity tools, like firefox,
    thunderbird, kvirc, syncthing or nextcloud-desktop.

nanolx-media-codecs:
    pulls additional codes for gstreamer, aswell as libdvdcss2 and libbluray2.

nanolx-media-cli:
    pulls cli media tools, like lame, sox, flac, streamripper or cdparanoia.

nanolx-media-x11:
    pulls ui media tools, like audacity, geeqie, okular, gimp, k3b and more.

nanolx-devel-cli:
    pulls cli development tools, like ccache, schroot, sbuild, gcc/g++, lintian,
    gdb, code checking tools and more.

nanolx-devel-android:
    pulls android related tools, like adb, fastboot, gradle and more.

nanolx-devel-x11:
    pulls ui development tools, like geany, bluefish, qownnotes and more.

nanolx-games:
    pulls a collection of games, including FreedroidRPG, Globulation2, Pingus,
    Suptertuxkart, Lincity-NG, Neverball, Lutris Launcher and Zelda fan games.

nanolx-games-emu:
    pulls a collection of emulators, including dosbox, retroarch and more.

nanolx-themes:
    this package provides a theme selection containing:
      - Plymouth:   debian mac style
      - rEFInd:     rEFInd digital void
      - Cursors:    Empty Butterfly
      - Qt:         Midnight Bright Kvantum
      - Icons:      Tela (red and red dark)
      - sddm:       Pixel Rainy Room
      - wall:       Matrixrain (Plasma 6)
      - splash:     Infinity (Plasma Splash 6)
      - KWin:
                effects:
                    Aura glow (burn my windows)
                    Geometry Changes
                scripts:
                    KNeko
                    KZones
                    Remember Window Positions
      - Plasmoids:  AndromedaLauncher, Advanced Separator, Panel Colorizer
      - Nothing for Plasma, KWin, Konsole including color schemes and wallpapers

nanolx-citrix-config:
    extra Citrix integration for Debian, see    Citrix    below.

Scripts
=======================================

Nanolx includes a set of scripts, all scripts ship their own manpage.

nanolx-base:
    nanolx-backup   create and manage systemd timers for rsync backups, alternatively
                    create backup triggers for when a specific device/partition was
                    plugged in (sends desktop notifications).

    nanolx-skel     enable / disable nanolx skel (/usr/share/nanolx/skel)
                    for newly created users instead of /etc/skel.
                    Note: you most likely /don't/ want that...

    conky-on-second-screen  this uses ydotool to force conky on second screen
                            this part of the nanolx skel files, so not in /usr
                            see skel/bin if you want to check it.

nanolx-apt-sources:
    nanolx-apt      manages additional repository configurations, including
                    key handling, aswell as matching pinning and minor apt
                    configuration changes (the latter both optional). Currently
                    known repos are: debian*, nanolx, liquorix, i2p, winehq,
                    deb-multimedia, mozilla. *rolls-out full suite stable->experimental

nanolx-apt-tools:
    repokit         personal wrapper script for reprepro with config file
                    support and many features.

    nanolx-orbit    manages installation of 3rdparty packages, including some
                    non-free packages, including checking sha256sums. Currently
                    supported: discord, pixes, citrix, citrix-usb, citrix-epa,
                    citrix-beta, citrix-usb-beta, zoom, zoom-vdi plugin, ulauncher,
                    appimagelauncher, kando, openrgb plugins: effects, hwsync, fansync.

nanolx-devel-cli:
    mksbuild        support script for repokit (possibly outdated).

nanolx-citrix-config:
    nanolx-ctx      script to disable (or enable [...]) citrix telemetry and
                    running the included system check script. It also allows to
                    install or uninstall the webkit2gtk-4.0 bundled with citrix,
                    which is required for full citrix operation, but no longer
                    shipped with Debian (or Ubuntu). It has more features, be
                    sure to check out, if you use citrix.

nanolx-net:
    hugo-push       simple script to build a hugo website and push it to webspace
                    using lftp, uses a configuration file.

nanolx-security:
    nanolx-pam-yubikey  script to enable password-less logins when a Yubikey
                        is plugged in, using PAM, currently hooked-into PAM
                        modules: login, sddm, su, sudo, sudo-i, polkit-1, kde.

nanolx-themes:
    nanolx-refind   simple script to manage rEFInd bootloader themes,
                    supports showing installed themes, setting theme,
                    showing current theme in use or reverting to default.

nanolx-x11:
    ydotoold.service    not a script, but a simple systemd user unit for running
                        ydotoold as a service.

Citrix
=======================================

The package
    nanolx-citrix-config

is not automatically pulled by nanolx-full, as it requires citrix, zoom, incl.
plugins to be already installed. For that purpose see the

    nanolx-orbit

script, which is bundled with nanolx-apt-tools. nanolx-citrix-config provides
additional system integrations (Menu entries, systemd services), as per

    https://aur.archlinux.org/packages/icaclient

The following only applies to stable Citrix versions which still use old libaries,
current Beta version use GCC 11 and newer libraries, so those tricks are now longer
required:

If Citrix Workspace fails to start, webkitgtk2-4.0 is likely missing, as it's no
longer shipped with Debian (or Ubuntu). Citrix bundles it's own version, so you
may choose to install that version using nanolx-ctx, at your own risk, via:

    nanolx-ctx load-webkit

Additionally nanolx-ctx features more useful commands, you might want to check.

Citrix requires libjpeg8 to run, which is not provided by Debian. Installing
libjpeg-turbo8 from UbuntU conflicts with installing libjpegturbo0 (which is
required by Krita), nanolx-citrix-config ships the libjpeg.so.8{,.2.2} from
Ubuntu itself.
