From 595684c36457065b3786ff7a52a8e3e8a1abb389 Mon Sep 17 00:00:00 2001 From: Albert S Date: Sun, 7 May 2023 19:46:43 +0200 Subject: [PATCH] Update docs --- CHANGELOG.md | 19 +++++++++++++++++++ README.md | 10 +++++++--- USAGE.md | 12 ++++-------- 3 files changed, 30 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c65669b..3b56eb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,24 @@ # looqs: Release notes +## 2023-05-07 - v0.9 +Highlights: Tag support. Also begin new index mode to only index metadata (currently only path + file size, more to come). + +Note: Upgrading can take some time as new column indexes will be added + +CHANGES: + + - gui: Improve font rendering in previews + - gui: Allow indexing only metadata + - gui: Allow adding content for files which only had metadata indexed before + - gui: Allow assigning tags by right clicking on paths + - cli: "add" command: Implement --verbose (-v) + - cli: "add" command: Implement --no-content and --fill-content + - cli: Add "tag" command which allows managing tags for paths. + - search: Add "tag:()", "t:()" filters + - Minor improvements and refactorings under the hood + - Add packages: Ubuntu 23.04. + + ## 2022-11-19 - v0.8.1 CHANGES: diff --git a/README.md b/README.md index 8477272..8978c39 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ To build on Ubuntu and Debian, clone the repo and then run: ``` git submodule init git submodule update -sudo apt install build-essential qtbase5-dev libpoppler-qt5-dev libuchardet-dev libquazip5-dev +sudo apt install build-essential qtbase5-dev libqt5sql5-sqlite libpoppler-qt5-dev libuchardet-dev libquazip5-dev qmake make ``` @@ -97,7 +97,9 @@ The GUI is located in `gui/looqs-gui`, the binary for the CLI is in `cli/looqs` ## Packages At this point, looqs is not in any official distro package repo, but I maintain some packages. -### Ubuntu 22.04, 22.10 + + +### Ubuntu 23.04, 22.10, 22.04 Latest release can be installed using apt from the repo. ``` # First, obtain key, assume it's trusted. @@ -108,6 +110,8 @@ echo "deb [arch=amd64 signed-by=/usr/share/keyrings/repo.quitesimple.org.gpg] ht sudo apt-get update sudo apt-get install looqs ``` +### Gentoo (EXPERIMENTAL) +Available in this overlay: https://github.com/quitesimpleorg/quitesimple-overlay ### Prebuilt tarball (distro-agnostic) (EXPERIMENTAL) looqs is also distributed as a tarball containing prebuilt binaries and its library dependencies. The tarball is @@ -134,7 +138,7 @@ An AppImage may accompany the tarball in the future. ### Other distros -I'll probably add a package for voidlinux at some point and maybe will provide a Gentoo ebuild. However, I would appreciate help for others distros. If you create a package, let me know! +I appreciate help for others distros. If you create a package, let me know! ### Signature verification diff --git a/USAGE.md b/USAGE.md index e92d064..c18e272 100644 --- a/USAGE.md +++ b/USAGE.md @@ -165,6 +165,8 @@ A number of search filters are available. | path.begins:(term) | pb:(term) | Filters path beginning with the specified term | | contains:(terms) | c:(terms) | Full-text search, also understands quotes | | limit:(integer) | - | Limits the number of results. The default is 1000. Say "limit:0" to see all results | +| tag:(tagname) | t:(tagname) | Filter for files that have been tagged with the corresponding tag | + Filters can be combined. The booleans AND and OR are supported. Negations can be applied too, except for c:(). Negations are specified with "!". The AND boolean is implicit and thus entering it strictly optional. @@ -177,11 +179,5 @@ Examples: |p:(notes) (pe:(odt) OR pe:(docx))          |Finds files such as notes.docx, notes.odt but also any .docs and .odt when the path contains the string 'notes'| |memcpy !(pe:(.c) OR pe:(.cpp))| Performs a FTS search for 'memcpy' but excludes .cpp and .c files.| |c:("I think, therefore")|Performs a FTS search for the phrase "I think, therefore".| -|c:("invoice") Downloads|This query is equivalent to c:("invoice") p:("Downloads")| - - - - - - - +|c:("invoice") Downloads|Equivalent to c:("invoice") p:("Downloads")| +|p:(Downloads) invoice|Equivalent to c:("invoice") p:("Downloads")|