├── version.txt ├── .github ├── FUNDING.yml └── workflows │ ├── test.yaml │ ├── upload-binaries.yaml │ └── release.yaml ├── testdata ├── version.txtar ├── no-permission.txtar ├── multi-line.txtar ├── wipe.txtar ├── flagconf.txtar ├── list-order.txtar ├── decode-by-argument.txtar ├── dedupe.txtar ├── test-image-and-preview-bmp.txtar ├── test-image-and-preview-gif.txtar ├── test-image-and-preview-jpg.txtar ├── test-image-and-preview-png.txtar ├── test-image-and-preview-tiff.txtar ├── multi-line-text-preview.txtar ├── clipboard-state-env-sensitive.txtar ├── truncate.txtar ├── max-dedupe.txtar ├── store-limit.txtar ├── clipboard-state-env-clear.txtar ├── delete.txtar ├── preview-width.txtar ├── min-store-length.txtar └── invalid-usage.txtar ├── contrib ├── cliphist-rofi ├── cliphist.service ├── cliphist-fzf-sixel ├── cliphist-fzf ├── cliphist-rofi-img ├── cliphist-wofi-img └── cliphist-fuzzel-img ├── go.mod ├── go.sum ├── cliphist_test.go ├── readme.md ├── CHANGELOG.md ├── cliphist.go └── LICENSE /version.txt: -------------------------------------------------------------------------------- 1 | 0.7.0 2 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: [sentriz] 2 | -------------------------------------------------------------------------------- /testdata/version.txtar: -------------------------------------------------------------------------------- 1 | exec cliphist version 2 | stderr '^version\t\d+\.\d+\.\d+$' 3 | -------------------------------------------------------------------------------- /contrib/cliphist-rofi: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | if [ -z "$1" ]; then 4 | cliphist list 5 | else 6 | cliphist decode <<<"$1" | wl-copy 7 | fi 8 | -------------------------------------------------------------------------------- /testdata/no-permission.txtar: -------------------------------------------------------------------------------- 1 | chmod 111 $HOME 2 | chmod 111 $XDG_CACHE_HOME 3 | 4 | exec rand 8 5 | stdin stdout 6 | ! exec cliphist store 7 | ! stdout . 8 | stderr 'permission denied' 9 | -------------------------------------------------------------------------------- /testdata/multi-line.txtar: -------------------------------------------------------------------------------- 1 | exec rand 2048 2 | cp stdout data-in 3 | 4 | stdin data-in 5 | exec cliphist store 6 | 7 | stdin query 8 | exec cliphist decode 9 | cp stdout data-out 10 | 11 | cmp data-in data-out 12 | 13 | -- query -- 14 | 1 x 15 | -------------------------------------------------------------------------------- /testdata/wipe.txtar: -------------------------------------------------------------------------------- 1 | exec rand 16 2 | stdin stdout 3 | exec cliphist store 4 | 5 | exec rand 16 6 | stdin stdout 7 | exec cliphist store 8 | 9 | exec rand 16 10 | stdin stdout 11 | exec cliphist store 12 | 13 | exec cliphist wipe 14 | ! stdout . 15 | 16 | exec cliphist list 17 | ! stdout . 18 | -------------------------------------------------------------------------------- /testdata/flagconf.txtar: -------------------------------------------------------------------------------- 1 | exec randstr 100 2 | stdin stdout 3 | exec cliphist store 4 | 5 | env CLIPHIST_PREVIEW_WIDTH=10 6 | exec cliphist list 7 | stdout '^.\t.{10}…$' 8 | 9 | env CLIPHIST_PREVIEW_WIDTH= 10 | exec cliphist -config-path conf list 11 | stdout '^.\t.{20}…$' 12 | 13 | -- conf -- 14 | preview-width 20 15 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module go.senan.xyz/cliphist 2 | 3 | go 1.20 4 | 5 | require ( 6 | github.com/rivo/uniseg v0.4.7 7 | github.com/rogpeppe/go-internal v1.12.0 8 | go.etcd.io/bbolt v1.3.9 9 | go.senan.xyz/flagconf v0.1.9 10 | golang.org/x/image v0.21.0 11 | ) 12 | 13 | require ( 14 | golang.org/x/sys v0.26.0 // indirect 15 | golang.org/x/tools v0.24.0 // indirect 16 | ) 17 | -------------------------------------------------------------------------------- /testdata/list-order.txtar: -------------------------------------------------------------------------------- 1 | stdin in-1 2 | exec cliphist store 3 | stdin in-2 4 | exec cliphist store 5 | stdin in-3 6 | exec cliphist store 7 | 8 | exec cliphist list 9 | cmp stdout out 10 | 11 | -- in-1 -- 12 | test input 1 13 | 14 | -- in-2 -- 15 | test input 2 16 | 17 | -- in-3 -- 18 | test input 3 19 | 20 | -- out -- 21 | 3 test input 3 22 | 2 test input 2 23 | 1 test input 1 24 | -------------------------------------------------------------------------------- /testdata/decode-by-argument.txtar: -------------------------------------------------------------------------------- 1 | stdin in-a 2 | exec cliphist store 3 | 4 | stdin in-b 5 | exec cliphist store 6 | 7 | exec cliphist decode 1 8 | stdout '^a$' 9 | 10 | exec cliphist decode 2 11 | stdout '^b$' 12 | 13 | ! exec cliphist decode 3 14 | stdout '^$' 15 | 16 | ! exec cliphist decode 17 | stderr 'input not prefixed with id' 18 | 19 | -- in-a -- 20 | a 21 | 22 | -- in-b -- 23 | b 24 | -------------------------------------------------------------------------------- /testdata/dedupe.txtar: -------------------------------------------------------------------------------- 1 | stdin in-a 2 | exec cliphist store 3 | 4 | stdin in-b 5 | exec cliphist store 6 | 7 | stdin in-a 8 | exec cliphist store 9 | 10 | stdin in-b 11 | exec cliphist store 12 | 13 | exec cliphist list 14 | cmp stdout out 15 | 16 | -- in-a -- 17 | my test input 18 | 19 | -- in-b -- 20 | my other test input 21 | 22 | -- out -- 23 | 4 my other test input 24 | 3 my test input 25 | -------------------------------------------------------------------------------- /testdata/test-image-and-preview-bmp.txtar: -------------------------------------------------------------------------------- 1 | exec bmp 2 | cp stdout in.bmp 3 | 4 | stdin stdout 5 | exec cliphist store 6 | 7 | # check we render preview 8 | exec cliphist list 9 | stdout '\[\[ binary data \d+ KiB bmp 20x20 \]\]' 10 | 11 | stdin query 12 | exec cliphist decode 13 | cp stdout out.bmp 14 | 15 | # check we didn't lose any bytes 16 | cmp in.bmp out.bmp 17 | 18 | -- query -- 19 | 1 20 | -------------------------------------------------------------------------------- /testdata/test-image-and-preview-gif.txtar: -------------------------------------------------------------------------------- 1 | exec gif 2 | cp stdout in.gif 3 | 4 | stdin stdout 5 | exec cliphist store 6 | 7 | # check we render preview 8 | exec cliphist list 9 | stdout '\[\[ binary data \d+ B gif 20x20 \]\]' 10 | 11 | stdin query 12 | exec cliphist decode 13 | cp stdout out.gif 14 | 15 | # check we didn't lose any bytes 16 | cmp in.gif out.gif 17 | 18 | -- query -- 19 | 1 20 | -------------------------------------------------------------------------------- /testdata/test-image-and-preview-jpg.txtar: -------------------------------------------------------------------------------- 1 | exec jpg 2 | cp stdout in.jpg 3 | 4 | stdin stdout 5 | exec cliphist store 6 | 7 | # check we render preview 8 | exec cliphist list 9 | stdout '\[\[ binary data \d+ B jpeg 20x20 \]\]' 10 | 11 | stdin query 12 | exec cliphist decode 13 | cp stdout out.jpg 14 | 15 | # check we didn't lose any bytes 16 | cmp in.jpg out.jpg 17 | 18 | -- query -- 19 | 1 20 | -------------------------------------------------------------------------------- /testdata/test-image-and-preview-png.txtar: -------------------------------------------------------------------------------- 1 | exec png 2 | cp stdout in.png 3 | 4 | stdin stdout 5 | exec cliphist store 6 | 7 | # check we render preview 8 | exec cliphist list 9 | stdout '\[\[ binary data \d+ B png 20x20 \]\]' 10 | 11 | stdin query 12 | exec cliphist decode 13 | cp stdout out.png 14 | 15 | # check we didn't lose any bytes 16 | cmp in.png out.png 17 | 18 | -- query -- 19 | 1 20 | -------------------------------------------------------------------------------- /testdata/test-image-and-preview-tiff.txtar: -------------------------------------------------------------------------------- 1 | exec tiff 2 | cp stdout in.tiff 3 | 4 | stdin stdout 5 | exec cliphist store 6 | 7 | # check we render preview 8 | exec cliphist list 9 | stdout '\[\[ binary data \d+ KiB tiff 20x20 \]\]' 10 | 11 | stdin query 12 | exec cliphist decode 13 | cp stdout out.tiff 14 | 15 | # check we didn't lose any bytes 16 | cmp in.tiff out.tiff 17 | 18 | -- query -- 19 | 1 20 | -------------------------------------------------------------------------------- /contrib/cliphist.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Wayland clipboard manager with support for multimedia 3 | PartOf=graphical-session.target 4 | After=graphical-session.target 5 | Requisite=graphical-session.target 6 | 7 | [Service] 8 | Type=simple 9 | ExecStart=/usr/bin/wl-paste --watch cliphist store 10 | Restart=on-failure 11 | 12 | [Install] 13 | WantedBy=graphical-session.target 14 | 15 | # vim:ft=dosini 16 | -------------------------------------------------------------------------------- /testdata/multi-line-text-preview.txtar: -------------------------------------------------------------------------------- 1 | stdin in 2 | exec cliphist store 3 | 4 | # preview should be flat 5 | exec cliphist list 6 | stdout '^1 a b c d e f g h i j$' 7 | stdout -count=1 '^.' 8 | 9 | # but what's stored should be identical 10 | stdin query 11 | exec cliphist decode 12 | cp stdout out 13 | cmp in out 14 | 15 | -- in -- 16 | a b 17 | c d e f 18 | g h i j 19 | 20 | -- query -- 21 | 1 22 | -------------------------------------------------------------------------------- /testdata/clipboard-state-env-sensitive.txtar: -------------------------------------------------------------------------------- 1 | env CLIPBOARD_STATE=data 2 | exec rand 8 3 | stdin stdout 4 | exec cliphist store 5 | 6 | # check 1 item with CLIPBOARD_STATE=data 7 | exec cliphist list 8 | stdout -count=1 '^.' 9 | 10 | exec cliphist wipe 11 | 12 | env CLIPBOARD_STATE=sensitive 13 | exec rand 8 14 | stdin stdout 15 | exec cliphist store 16 | 17 | # check 0 items with CLIPBOARD_STATE=sensitive 18 | exec cliphist list 19 | ! stdout . 20 | -------------------------------------------------------------------------------- /testdata/truncate.txtar: -------------------------------------------------------------------------------- 1 | stdin in 2 | exec cliphist store 3 | 4 | exec cliphist list 5 | stdout '^1 one two three four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen sev…$' 6 | 7 | -- in -- 8 | one 9 | two 10 | three 11 | four 12 | five 13 | six 14 | seven 15 | eight 16 | nine 17 | ten 18 | eleven 19 | twelve 20 | thirteen 21 | fourteen 22 | fifteen 23 | sixteen 24 | seventeen 25 | eighteen 26 | nineteen 27 | twenty 28 | -------------------------------------------------------------------------------- /testdata/max-dedupe.txtar: -------------------------------------------------------------------------------- 1 | stdin in 2 | exec cliphist store 3 | 4 | exec rand 8 5 | stdin stdout 6 | exec cliphist store 7 | 8 | stdin in 9 | exec cliphist store 10 | 11 | exec cliphist list 12 | stdout -count=2 '^.' 13 | 14 | exec rand 8 15 | stdin stdout 16 | exec cliphist store 17 | 18 | exec cliphist list 19 | stdout -count=3 '^.' 20 | 21 | stdin in 22 | exec cliphist -max-dedupe-search=0 store 23 | 24 | exec cliphist list 25 | stdout -count=4 '^.' 26 | 27 | -- in -- 28 | test line 29 | -------------------------------------------------------------------------------- /testdata/store-limit.txtar: -------------------------------------------------------------------------------- 1 | exec rand 16 2 | stdin stdout 3 | exec cliphist -max-items 2 store 4 | 5 | exec rand 16 6 | stdin stdout 7 | exec cliphist -max-items 2 store 8 | 9 | exec rand 16 10 | stdin stdout 11 | exec cliphist -max-items 2 store 12 | 13 | # we only kept 2 14 | exec cliphist list 15 | ! stdout '^1\t' 16 | stdout '^2\t' 17 | stdout '^3\t' 18 | 19 | exec rand 16 20 | stdin stdout 21 | exec cliphist -max-items 0 store 22 | 23 | # 0 clears the lot 24 | exec cliphist list 25 | ! stdout . 26 | ! stderr . 27 | -------------------------------------------------------------------------------- /contrib/cliphist-fzf-sixel: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | case "$1" in 4 | preview) 5 | row="$2" 6 | if echo "$row" | grep -vqP '^\d+\t\[\[ binary data .* \]\]'; then 7 | echo "$row" | cliphist decode 8 | else 9 | echo "$row" | cliphist decode | chafa -f sixel -s "${FZF_PREVIEW_COLUMNS}x${FZF_PREVIEW_LINES}" 10 | fi 11 | ;; 12 | 13 | *) 14 | id="$(cliphist list | fzf --preview "$(realpath "$0") preview {}")" 15 | test -z "$id" && exit 16 | 17 | cliphist decode <<<"$id" | wl-copy 18 | ;; 19 | 20 | esac 21 | -------------------------------------------------------------------------------- /contrib/cliphist-fzf: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # Outputs only unique lines and shows preview for the highlighted non-binary item 3 | 4 | case "$1" in 5 | preview) 6 | # show preview if non-binary data 7 | echo "$2" | grep -q '[\[ binary data .* \]\]' || echo "$2" | cliphist decode 8 | ;; 9 | *) 10 | exec cliphist list | 11 | sort -k 2 -u | # sort by 2 field to the end of line and output only unique lines 12 | sort -nr | # sort numerically in reverse 13 | fzf --preview "$(realpath "$0") preview {}" | 14 | cliphist decode | 15 | wl-copy 16 | ;; 17 | esac 18 | -------------------------------------------------------------------------------- /contrib/cliphist-rofi-img: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | tmp_dir="/tmp/cliphist" 4 | rm -rf "$tmp_dir" 5 | 6 | if [[ -n "$1" ]]; then 7 | cliphist decode <<<"$1" | wl-copy 8 | exit 9 | fi 10 | 11 | mkdir -p "$tmp_dir" 12 | 13 | read -r -d '' prog <$tmp_dir/"grp[1]"."grp[3]) 17 | print \$0"\0icon\x1f$tmp_dir/"grp[1]"."grp[3] 18 | next 19 | } 20 | 1 21 | EOF 22 | cliphist list | gawk "$prog" 23 | -------------------------------------------------------------------------------- /testdata/clipboard-state-env-clear.txtar: -------------------------------------------------------------------------------- 1 | stdin in-1 2 | exec cliphist store 3 | stdin in-2 4 | exec cliphist store 5 | stdin in-3 6 | exec cliphist store 7 | 8 | exec cliphist list 9 | cmp stdout out-before 10 | 11 | env CLIPBOARD_STATE=clear 12 | exec cliphist store 13 | 14 | exec cliphist list 15 | cmp stdout out-after 16 | 17 | -- in-1 -- 18 | test input 1 19 | 20 | -- in-2 -- 21 | test input 2 22 | 23 | -- in-3 -- 24 | test input 3 25 | 26 | -- out-before -- 27 | 3 test input 3 28 | 2 test input 2 29 | 1 test input 1 30 | -- out-after -- 31 | 2 test input 2 32 | 1 test input 1 33 | -------------------------------------------------------------------------------- /.github/workflows/test.yaml: -------------------------------------------------------------------------------- 1 | name: Lint and test 2 | on: 3 | push: 4 | branches: 5 | - develop 6 | pull_request: 7 | jobs: 8 | test: 9 | name: Lint and test 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: Checkout 13 | uses: actions/checkout@v3 14 | - name: Setup Go 15 | uses: actions/setup-go@v4 16 | with: 17 | go-version-file: go.mod 18 | - name: Lint 19 | uses: golangci/golangci-lint-action@v4 20 | with: 21 | version: v1.54 22 | - name: Test 23 | run: go test ./... 24 | -------------------------------------------------------------------------------- /testdata/delete.txtar: -------------------------------------------------------------------------------- 1 | stdin in-good 2 | exec cliphist store 3 | 4 | stdin in-bad-1 5 | exec cliphist store 6 | stdin in-bad-2 7 | exec cliphist store 8 | stdin in-bad-3 9 | exec cliphist store 10 | 11 | stdin delete-query 12 | exec cliphist delete 13 | 14 | exec cliphist delete-query 'bad-3' 15 | exec cliphist delete-query 'i dont exist' 16 | 17 | exec cliphist list 18 | cmp stdout out 19 | 20 | -- in-good -- 21 | im a test 22 | -- in-bad-1 -- 23 | im a bad-1 test 24 | -- in-bad-2 -- 25 | im a bad-2 test 26 | -- in-bad-3 -- 27 | im a bad-3 test 28 | 29 | -- delete-query -- 30 | 2 x 31 | 3 x 32 | -- out -- 33 | 1 im a test 34 | -------------------------------------------------------------------------------- /testdata/preview-width.txtar: -------------------------------------------------------------------------------- 1 | # default width is 100 2 | exec randstr 100 3 | stdin stdout 4 | exec cliphist store 5 | exec cliphist list 6 | ! stdout … 7 | 8 | exec randstr 101 9 | stdin stdout 10 | exec cliphist store 11 | exec cliphist list 12 | stdout … 13 | 14 | exec randstr 1000 15 | stdin stdout 16 | exec cliphist store 17 | exec cliphist -preview-width 1000 list 18 | ! stdout … 19 | 20 | exec randstr 1001 21 | stdin stdout 22 | exec cliphist store 23 | exec cliphist -preview-width 1000 list 24 | stdout -count=1 … 25 | 26 | ! exec cliphist -preview-width -10 list 27 | 28 | exec cliphist -preview-width 1 list 29 | stdout -count=4 '.\t.…' 30 | 31 | exec cliphist -preview-width 0 list 32 | stdout -count=4 '.\t…' 33 | -------------------------------------------------------------------------------- /testdata/min-store-length.txtar: -------------------------------------------------------------------------------- 1 | exec randstr 16 2 | stdin stdout 3 | exec cliphist store 4 | 5 | exec randstr 3 6 | stdin stdout 7 | exec cliphist -min-store-length 3 store 8 | 9 | # we stored everything so far 10 | exec cliphist list 11 | stdout -count=2 '^.' 12 | 13 | exec randstr 4 14 | stdin stdout 15 | exec cliphist -min-store-length 3 store 16 | 17 | # we can store the last, since 4 > 3 18 | exec cliphist list 19 | stdout -count=3 '^.' 20 | 21 | exec randstr 2 22 | stdin stdout 23 | exec cliphist -min-store-length 3 store 24 | 25 | # not the last, since 4 > 3 26 | exec cliphist list 27 | stdout -count=3 '^.' 28 | 29 | exec randstr 3 30 | stdin stdout 31 | exec cliphist -min-store-length 3 store 32 | 33 | # last is fine, 3 == 3 34 | exec cliphist list 35 | stdout -count=4 '^.' 36 | -------------------------------------------------------------------------------- /testdata/invalid-usage.txtar: -------------------------------------------------------------------------------- 1 | ! exec cliphist 2 | ! stdout . 3 | stderr '^usage:' 4 | stderr '^options:' 5 | 6 | ! exec cliphist hello 7 | ! stdout . 8 | stderr '^usage:' 9 | stderr '^options:' 10 | 11 | ! exec cliphist -unknown 12 | ! stdout . 13 | stderr '^usage:' 14 | stderr '^options:' 15 | 16 | # should store first 17 | ! exec cliphist list 18 | stderr 'please store something first' 19 | 20 | exec rand 16 21 | exec cliphist store 22 | 23 | # delete query 24 | ! exec cliphist delete-query 25 | ! stdout . 26 | stderr 'please provide a query' 27 | 28 | # decode id check 29 | ! exec cliphist decode 30 | ! stdout . 31 | stderr 'input not prefixed with id' 32 | 33 | # invalid id 34 | stdin in-invalid-id 35 | ! exec cliphist decode 36 | ! stdout . 37 | stderr 'parsing "a": invalid syntax' 38 | 39 | -- in-invalid-id -- 40 | a x 41 | -------------------------------------------------------------------------------- /.github/workflows/upload-binaries.yaml: -------------------------------------------------------------------------------- 1 | name: Upload binaries 2 | on: 3 | push: 4 | tags: 5 | - "*" 6 | jobs: 7 | build-and-upload: 8 | name: Build and upload 9 | runs-on: ubuntu-latest 10 | strategy: 11 | matrix: 12 | include: 13 | - os: linux 14 | arch: amd64 15 | - os: linux 16 | arch: arm 17 | - os: linux 18 | arch: 386 19 | steps: 20 | - name: Checkout 21 | uses: actions/checkout@v3 22 | - name: Setup Go 23 | uses: actions/setup-go@v4 24 | with: 25 | go-version-file: go.mod 26 | - name: Build binary 27 | run: | 28 | GOOS=${{ matrix.os }} GOARCH=${{ matrix.arch }} CGO_ENABLED=0 go build -a -ldflags '-extldflags "-static"' -o cliphist-${{ github.ref }}-${{ matrix.os }}-${{ matrix.arch }} . 29 | - name: Upload 30 | uses: svenstaro/upload-release-action@v2 31 | with: 32 | repo_token: ${{ secrets.CR_PAT }} 33 | file: cliphist-${{ github.ref }}-${{ matrix.os }}-${{ matrix.arch }} 34 | tag: ${{ github.ref }} 35 | -------------------------------------------------------------------------------- /.github/workflows/release.yaml: -------------------------------------------------------------------------------- 1 | name: Release 2 | on: 3 | push: 4 | branches: 5 | - master 6 | jobs: 7 | test: 8 | name: Lint and test 9 | runs-on: ubuntu-latest 10 | steps: 11 | - name: Checkout 12 | uses: actions/checkout@v3 13 | - name: Setup Go 14 | uses: actions/setup-go@v4 15 | with: 16 | go-version-file: go.mod 17 | - name: Lint 18 | uses: golangci/golangci-lint-action@v4 19 | with: 20 | version: v1.54 21 | - name: Test 22 | run: go test ./... 23 | release-please: 24 | name: Run Release Please 25 | runs-on: ubuntu-latest 26 | needs: [test] 27 | outputs: 28 | release_created: ${{ steps.release.outputs.release_created }} 29 | tag_name: ${{ steps.release.outputs.tag_name }} 30 | steps: 31 | - name: Checkout repository 32 | uses: actions/checkout@v2 33 | - name: Setup Release Please 34 | uses: google-github-actions/release-please-action@v2 35 | id: release 36 | with: 37 | token: ${{ secrets.CR_PAT }} 38 | release-type: simple 39 | changelog-path: CHANGELOG.md 40 | package-name: cliphist 41 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 2 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 3 | github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= 4 | github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= 5 | github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8= 6 | github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4= 7 | github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= 8 | go.etcd.io/bbolt v1.3.9 h1:8x7aARPEXiXbHmtUwAIv7eV2fQFHrLLavdiJ3uzJXoI= 9 | go.etcd.io/bbolt v1.3.9/go.mod h1:zaO32+Ti0PK1ivdPtgMESzuzL2VPoIG1PCQNvOdo/dE= 10 | go.senan.xyz/flagconf v0.1.9 h1:LBDmqiVFgijfqFXDzH97gPn0qDbg1Dq6/vxsxS/TzC4= 11 | go.senan.xyz/flagconf v0.1.9/go.mod h1:NqOFfSwJvNWXOTUabcRZ8mPK9+sJmhStJhqtEt74wNQ= 12 | golang.org/x/image v0.21.0 h1:c5qV36ajHpdj4Qi0GnE0jUc/yuo33OLFaa0d+crTD5s= 13 | golang.org/x/image v0.21.0/go.mod h1:vUbsLavqK/W303ZroQQVKQ+Af3Yl6Uz1Ppu5J/cLz78= 14 | golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ= 15 | golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo= 16 | golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= 17 | golang.org/x/tools v0.24.0 h1:J1shsA93PJUEVaUSaay7UXAyE8aimq3GW0pjlolpa24= 18 | golang.org/x/tools v0.24.0/go.mod h1:YhNqVBIfWHdzvTLs0d8LCuMhkKUgSUKldakyV7W/WDQ= 19 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 20 | -------------------------------------------------------------------------------- /contrib/cliphist-wofi-img: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # executes same behaviour as below but with support for images 4 | # 5 | # cliphist list | wofi --dmenu | cliphist decode 6 | # 7 | # produces thumbnails and stores them in XDG_CACHE_HOME 8 | # note: does NOT put in clipboard, call wl-copy yourself! 9 | 10 | # set up thumbnail directory 11 | thumb_dir="${XDG_CACHE_HOME:-$HOME/.cache}/cliphist/thumbs" 12 | mkdir -p "$thumb_dir" 13 | 14 | cliphist_list="$(cliphist list)" 15 | 16 | # delete thumbnails in cache but not in cliphist 17 | for thumb in "$thumb_dir"/*; do 18 | clip_id="${thumb##*/}" 19 | clip_id="${clip_id%.*}" 20 | check=$(rg <<< "$cliphist_list" "^$clip_id\s") 21 | if [ -z "$check" ]; then 22 | >&2 rm -v "$thumb" 23 | fi 24 | done 25 | 26 | # remove unnecessary image tags 27 | # create thumbnail if image not processed already 28 | # print escape sequence 29 | read -r -d '' prog <' $thumb_dir/"image ) 34 | print "img:$thumb_dir/"image 35 | next 36 | } 37 | 1 38 | EOF 39 | 40 | choice=$(gawk <<< $cliphist_list "$prog" | wofi -I --dmenu --cache-file=/dev/null -Dimage_size=100 -Dynamic_lines=true) 41 | 42 | # stop execution if nothing selected in wofi menu 43 | [ -z "$choice" ] && exit 1 44 | 45 | if [ "${choice::4}" = "img:" ]; then 46 | thumb_file="${choice:4}" 47 | clip_id="${thumb_file##*/}" 48 | clip_id="${clip_id%.*}\t" 49 | else 50 | clip_id="${choice}" 51 | fi 52 | 53 | printf "$clip_id" | cliphist decode 54 | -------------------------------------------------------------------------------- /cliphist_test.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "crypto/rand" 5 | "fmt" 6 | "image" 7 | "image/gif" 8 | "image/jpeg" 9 | "image/png" 10 | "io" 11 | mathrand "math/rand" 12 | "os" 13 | "strconv" 14 | "testing" 15 | 16 | "github.com/rogpeppe/go-internal/testscript" 17 | "golang.org/x/image/bmp" 18 | "golang.org/x/image/tiff" 19 | ) 20 | 21 | func TestMain(m *testing.M) { 22 | testImage := image.NewRGBA(image.Rectangle{Max: image.Point{20, 20}}) 23 | 24 | os.Exit(testscript.RunMain(m, map[string]func() int{ 25 | "cliphist": func() int { main(); return 0 }, 26 | 27 | "rand": func() int { 28 | size, _ := strconv.Atoi(os.Args[1]) 29 | _, _ = io.CopyN(os.Stdout, rand.Reader, int64(size)) 30 | return 0 31 | }, 32 | "randstr": func() int { 33 | size, _ := strconv.Atoi(os.Args[1]) 34 | const letterBytes = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ" 35 | b := make([]byte, size) 36 | for i := range b { 37 | b[i] = letterBytes[mathrand.Intn(len(letterBytes))] 38 | } 39 | os.Stdout.Write(b) 40 | return 0 41 | }, 42 | 43 | "gif": func() int { _ = gif.Encode(os.Stdout, testImage, nil); return 0 }, 44 | "jpg": func() int { _ = jpeg.Encode(os.Stdout, testImage, nil); return 0 }, 45 | "png": func() int { _ = png.Encode(os.Stdout, testImage); return 0 }, 46 | "bmp": func() int { _ = bmp.Encode(os.Stdout, testImage); return 0 }, 47 | "tiff": func() int { _ = tiff.Encode(os.Stdout, testImage, nil); return 0 }, 48 | })) 49 | } 50 | 51 | func TestScripts(t *testing.T) { 52 | testscript.Run(t, testscript.Params{ 53 | Dir: "testdata", 54 | RequireExplicitExec: true, 55 | Setup: func(env *testscript.Env) error { 56 | env.Vars = append(env.Vars, fmt.Sprintf("HOME=%s", env.WorkDir)) 57 | env.Vars = append(env.Vars, fmt.Sprintf("XDG_CACHE_HOME=%s", env.WorkDir)) 58 | return nil 59 | }, 60 | }) 61 | } 62 | -------------------------------------------------------------------------------- /contrib/cliphist-fuzzel-img: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | thumbnail_dir="${XDG_CACHE_HOME:-$HOME/.cache}/cliphist/thumbnails" 4 | 5 | cliphist_list=$(cliphist list) 6 | if [ -z "$cliphist_list" ]; then 7 | fuzzel -d --prompt-only "cliphist: please store something first " 8 | rm -rf "$thumbnail_dir" 9 | exit 10 | fi 11 | 12 | [ -d "$thumbnail_dir" ] || mkdir -p "$thumbnail_dir" 13 | 14 | # Write binary image to cache file if it doesn't exist 15 | read -r -d '' thumbnail <${thumbnail_dir}/"thumbnail_file) 22 | print \$0"\0icon\x1f${thumbnail_dir}/"thumbnail_file 23 | next 24 | } 25 | 1 26 | EOF 27 | 28 | item=$(echo "$cliphist_list" | gawk "$thumbnail" | fuzzel -d --placeholder "Search clipboard..." --counter --no-sort --with-nth 2) 29 | exit_code=$? 30 | 31 | # ALT+0 to clear history 32 | if [ "$exit_code" -eq 19 ]; then 33 | confirmation=$(echo -e "No\nYes" | fuzzel -d --placeholder "Delete history?" --lines 2) 34 | [ "$confirmation" == "Yes" ] && rm ~/.cache/cliphist/db && rm -rf "$thumbnail_dir" 35 | # ALT+1 to delete selected item 36 | # configure the keybind with `custom-1` in your fuzzel.ini 37 | elif [ "$exit_code" -eq 10 ]; then 38 | if [ -n "$item" ]; then 39 | item_id=$(echo "$item" | cut -f1) 40 | echo "$item_id" | cliphist delete 41 | find "$thumbnail_dir" -name "${item_id}.*" -delete 42 | fi 43 | else 44 | [ -z "$item" ] || echo "$item" | cliphist decode | wl-copy 45 | fi 46 | 47 | # Delete cached thumbnails that are no longer in cliphist db 48 | find "$thumbnail_dir" -type f | while IFS= read -r thumbnail_file; do 49 | cliphist_item_id=$(basename "${thumbnail_file%.*}") 50 | if ! grep -q "^${cliphist_item_id}\s\[\[ binary data" <<<"$cliphist_list"; then 51 | rm "$thumbnail_file" 52 | fi 53 | done 54 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | ### cliphist 2 | 3 | _Clipboard history “manager” for Wayland_ 4 | 5 | - Write clipboard changes to a history file. 6 | - Recall history with **dmenu**, **rofi**, **wofi** (or whatever other picker you like). 7 | - Both **text** and **images** are supported. 8 | - Clipboard is preserved **byte-for-byte**. 9 | - Leading/trailing whitespace, no whitespace, or newlines are preserved. 10 | - Won’t break fancy editor selections like Vim wordwise, linewise, or block mode. 11 | - No concept of a picker, only pipes. 12 | 13 | Requires [Go](https://golang.org/), [wl-clipboard](https://github.com/bugaevc/wl-clipboard), xdg-utils (for image MIME inference). 14 | 15 | --- 16 | 17 | ### Install 18 | 19 | - You could try using [your distro's repos](#packaging) if it's available there. 20 | - Or stick a static binary from the [releases page](https://github.com/sentriz/cliphist/releases) somewhere in your `$PATH`. 21 | - Or just install it from source with [Go](https://go.dev/doc/install) and `$ go install go.senan.xyz/cliphist@latest`. 22 | 23 | --- 24 | 25 | ### Usage 26 | 27 | #### Listen for clipboard changes 28 | 29 | `$ wl-paste --watch cliphist store` 30 | This will listen for changes on your primary clipboard and write them to the history. 31 | Call it once per session - for example, in your Sway config. 32 | 33 | #### Select an old item 34 | 35 | `$ cliphist list | dmenu | cliphist decode | wl-copy` 36 | Bind it to something nice on your keyboard. 37 | 38 | #### Delete an old item 39 | 40 | `$ cliphist list | dmenu | cliphist delete` 41 | Or else query manually: 42 | `$ cliphist delete-query "secret item"`. 43 | 44 | #### Clear database 45 | 46 | `$ cliphist wipe`. 47 | 48 | --- 49 | 50 | ### Picker examples 51 | 52 |
53 | dmenu 54 | 55 | `cliphist list | dmenu | cliphist decode | wl-copy` 56 | 57 |
58 | 59 |
60 | fzf 61 | 62 | `cliphist list | fzf --no-sort | cliphist decode | wl-copy` 63 | 64 |
65 | 66 |
67 | rofi (dmenu mode) 68 | 69 | `cliphist list | rofi -dmenu | cliphist decode | wl-copy` 70 | 71 |
72 | 73 |
74 | fuzzel (dmenu mode) 75 | 76 | `cliphist list | fuzzel --dmenu | cliphist decode | wl-copy` 77 | 78 |
79 | 80 |
81 | fuzzel (dmenu mode with images) 82 | 83 | `./cliphist-fuzzel-img` 84 | 85 | (Requires [contrib/cliphist-fuzzel-img](./contrib/cliphist-fuzzel-img)) 86 | 87 |
88 | 89 |
90 | rofi (custom mode) 91 | 92 | `rofi -modi clipboard:/path/to/cliphist-rofi -show clipboard` 93 | 94 | (Requires [contrib/cliphist-rofi](https://github.com/sentriz/cliphist/blob/master/contrib/cliphist-rofi)). 95 | 96 |
97 | 98 |
99 | rofi (custom mode with images) 100 | 101 | `rofi -modi clipboard:/path/to/cliphist-rofi-img -show clipboard -show-icons` 102 | 103 | (Requires [contrib/cliphist-rofi-img](https://github.com/sentriz/cliphist/blob/master/contrib/cliphist-rofi-img)). 104 | 105 |
106 | 107 |
108 | wofi 109 | 110 | `cliphist list | wofi -S dmenu | cliphist decode | wl-copy` 111 | 112 | Example config for Sway: 113 | 114 | ``` 115 | exec wl-paste --watch cliphist store 116 | bindsym Mod1+p exec cliphist list | wofi -S dmenu | cliphist decode | wl-copy 117 | ``` 118 | 119 |
120 | 121 | --- 122 | 123 | ### FAQ 124 | 125 |
126 | Why do I have numbers in my picker? Can I get rid of them? 127 | 128 | It's important that a line prefixed with a number is piped into `cliphist decode`. This number is used to look up in the database the exact original selection that you made, with all leading, trailing, non-printable, etc. whitespace preserved. None of that will be shown in the preview output of `cliphist list`. 129 | 130 | Since the format of `cliphist list` is `"\t<100 char preview>"`, and most pickers consider `"\t"` to be a column separator, you can try to just select column number 2. 131 | 132 | ```shell 133 | # fzf 134 | cliphist list | fzf -d $'\t' --with-nth 2 | cliphist decode | wl-copy 135 | ``` 136 | 137 | ```shell 138 | # rofi 139 | cliphist list | rofi -dmenu -display-columns 2 | cliphist decode | wl-copy 140 | ``` 141 | 142 | ```shell 143 | # fuzzel 144 | cliphist list | fuzzel --dmenu --with-nth 2 | cliphist decode | wl-copy 145 | ``` 146 | 147 | ```shell 148 | # wofi 149 | # It kind of works but breaks with quotes in the original selection. I recommend not trying to hide the column with wofi. 150 | cliphist list | wofi --dmenu --pre-display-cmd "echo '%s' | cut -f 2" | cliphist decode | wl-copy 151 | ``` 152 | 153 |
154 | 155 |
156 | How do I narrow down the items that are copied to cliphist, or always copy images from my browser? 157 | 158 | It's also possible to run `wl-paste --watch` several times for multiple MIME types. 159 | 160 | For example, in your window manager's startup, you could run: 161 | 162 | ``` 163 | wl-paste --type text --watch cliphist store 164 | wl-paste --type image --watch cliphist store 165 | ``` 166 | 167 | Now you should have text and raw image data available in your history. Make sure you have xdg-utils installed too. 168 | 169 |
170 | 171 | --- 172 | 173 | ### Packaging 174 | 175 | [![](https://repology.org/badge/vertical-allrepos/cliphist.svg?columns=4)](https://repology.org/project/cliphist/versions) 176 | 177 | --- 178 | 179 | ### Demo 180 | 181 | 182 | 183 | --- 184 | 185 | ### Configuration 186 | 187 | `cliphist` can be optionally configured to extend the default functionality. Any option can be provided with a CLI argument, environment variable, or config file key. 188 | 189 | For example, the option `max-items`, can be set via the CLI as `-max-items 100`, as an environment variable `CLIPHIST_MAX_ITEMS=100`, or in the config file as `max-items 100`. 190 | 191 | If you choose to use the config file, the default location is `$XDG_CONFIG_HOME/cliphist/config`. The format is a text file with one option per line, where each line is ` `. For example: 192 | 193 | ``` 194 | # example cliphist config 195 | max-items 1000 196 | max-dedupe-search 200 197 | ``` 198 | 199 | The list of available options is: 200 | 201 | | CLI argument | Environment variable | Config file key | Description | 202 | | ------------------ | --------------------------- | ----------------- | --------------------------------------------------------------------------------------------- | 203 | | -max-dedupe-search | CLIPHIST_MAX_DEDEUPE_SEARCH | max-dedupe-search | (Optional) maximum number of last items to look through when finding duplicates (default 100) | 204 | | -max-items | CLIPHIST_MAX_ITEMS | max-items | (Optional) maximum number of items to store (default 750) | 205 | | -min-store-length | CLIPHIST_MIN_STORE_LENGTH | min-store-length | (Optional) minimum number of characters to store | 206 | | -preview-width | CLIPHIST_PREVIEW_WIDTH | preview-width | (Optional) maximum number of characters to preview (default 100) | 207 | | -db-path | CLIPHIST_DB_PATH | db-path | (Optional) path to db (default `$XDG_CACHE_HOME/cliphist/db`) | 208 | | -config-path | CLIPHIST_CONFIG_PATH | | (Optional) path to config (default `$XDG_CONFIG_HOME/cliphist/config`) | 209 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## [0.7.0](https://www.github.com/sentriz/cliphist/compare/v0.6.1...v0.7.0) (2025-10-11) 4 | 5 | A small release, mostly featuring the `min-store-length` option. 6 | 7 | ### Features 8 | 9 | * add `min-store-length` option ([e18c06a](https://www.github.com/sentriz/cliphist/commit/e18c06a316a4c25741d2b3e721c7b4a9ff85390c)), closes [#62](https://www.github.com/sentriz/cliphist/issues/62) [#157](https://www.github.com/sentriz/cliphist/issues/157) 10 | * compact db after wiping ([9fb195b](https://www.github.com/sentriz/cliphist/commit/9fb195b66d8dfd5950416efdd47f7a62a8d32cd0)), closes [#155](https://www.github.com/sentriz/cliphist/issues/155) 11 | * **contrib:** add fuzzel img script ([#144](https://www.github.com/sentriz/cliphist/issues/144)) ([9dac7d3](https://www.github.com/sentriz/cliphist/commit/9dac7d3ff533140ad31e835a413a8380b99f96d3)) 12 | * **contrib:** add option to delete specific entry in cliphist-fuzzel-img ([#148](https://www.github.com/sentriz/cliphist/issues/148)) ([ff1d247](https://www.github.com/sentriz/cliphist/commit/ff1d247e3521bd7ebcb6463f86349bab71440496)) 13 | * **contrib:** add systemd service ([#138](https://www.github.com/sentriz/cliphist/issues/138)) ([e626b1b](https://www.github.com/sentriz/cliphist/commit/e626b1b60083453b4ff74f7c8dc251415e2abbc4)) 14 | * **contrib:** cliphist-wofi-img: disable cache ([#156](https://www.github.com/sentriz/cliphist/issues/156)) ([5c33a7d](https://www.github.com/sentriz/cliphist/commit/5c33a7d8d4bb7bf44fe0526d7451edca2157ab75)) 15 | * **contrib:** drop imagemagick in cliphist-fuzzel-img ([#153](https://www.github.com/sentriz/cliphist/issues/153)) ([6eda526](https://www.github.com/sentriz/cliphist/commit/6eda526d02119ebc09ec0f64b0a96ed4540f5a83)) 16 | * **contrib:** use portable shebang lines ([#147](https://www.github.com/sentriz/cliphist/issues/147)) ([f49bd90](https://www.github.com/sentriz/cliphist/commit/f49bd905cff72d32d62c209224353865436f9a13)) 17 | * support tiff images ([1350191](https://www.github.com/sentriz/cliphist/commit/1350191061a7df1f70cd6e652eb0517d3a9a590f)), closes [#126](https://www.github.com/sentriz/cliphist/issues/126) 18 | 19 | 20 | ### Bug Fixes 21 | 22 | * error when id not during decode ([b35d005](https://www.github.com/sentriz/cliphist/commit/b35d00590a9fccc4285d562938c5428c9eaa6a37)), closes [#159](https://www.github.com/sentriz/cliphist/issues/159) 23 | * min-store-length sets max length instead of min ([#163](https://www.github.com/sentriz/cliphist/issues/163)) ([a94f192](https://www.github.com/sentriz/cliphist/commit/a94f192d94e43eee2d58fff6fb3733702eadb854)) 24 | 25 | ### [0.6.1](https://www.github.com/sentriz/cliphist/compare/v0.6.0...v0.6.1) (2024-10-15) 26 | 27 | 28 | ### Bug Fixes 29 | 30 | * case when no XDG_{CACHE,CONFIG}_HOME ([b3d4bd4](https://www.github.com/sentriz/cliphist/commit/b3d4bd49e801a0b3438074911909dadace7ee0fb)), closes [#118](https://www.github.com/sentriz/cliphist/issues/118) 31 | 32 | ## [0.6.0](https://www.github.com/sentriz/cliphist/compare/v0.5.0...v0.6.0) (2024-10-15) 33 | 34 | 35 | ### Features 36 | 37 | * add -preview-width option to limit char width of preview ([#88](https://www.github.com/sentriz/cliphist/issues/88)) ([4714de1](https://www.github.com/sentriz/cliphist/commit/4714de1cc6c58854a42199598b5e926f1fd50e4e)) 38 | * **contrib:** resize images in wofi script to make them clearly visible ([#105](https://www.github.com/sentriz/cliphist/issues/105)) ([05d29dc](https://www.github.com/sentriz/cliphist/commit/05d29dc332ff9e9895ec1a6f21a828faa5d34555)) 39 | * **contrib:** use "magick" instead of "convert" ([#104](https://www.github.com/sentriz/cliphist/issues/104)) ([c164c4c](https://www.github.com/sentriz/cliphist/commit/c164c4c3f88c4bde94b0fe6edc5672b9bf1c0c8a)) 40 | * make db path configurable (flag / env var / config file) ([19ef90e](https://www.github.com/sentriz/cliphist/commit/19ef90ee35e6e3b27219d38ee43c82f52402431b)), closes [#91](https://www.github.com/sentriz/cliphist/issues/91) 41 | * support configuration via env var or config file ([#90](https://www.github.com/sentriz/cliphist/issues/90)) ([08ee1fb](https://www.github.com/sentriz/cliphist/commit/08ee1fbe04610b01c0bd70fb9492f2338e1b9f4d)) 42 | 43 | 44 | ### Bug Fixes 45 | 46 | * correctly truncate utf-8 string ([9128c08](https://www.github.com/sentriz/cliphist/commit/9128c08fd4e24464ddcede6c5a0d32dabfc1ec09)), closes [#82](https://www.github.com/sentriz/cliphist/issues/82) 47 | 48 | ## [0.5.0](https://www.github.com/sentriz/cliphist/compare/v0.4.0...v0.5.0) (2023-12-12) 49 | 50 | 51 | ### Features 52 | 53 | * accept multiple input lines for `cliphist delete` ([fbc54c0](https://www.github.com/sentriz/cliphist/commit/fbc54c0fe4c930cd24eb3c70134c3c3a1b3dcd2d)), closes [#63](https://www.github.com/sentriz/cliphist/issues/63) 54 | * add support for bmp images ([3c9a7b8](https://www.github.com/sentriz/cliphist/commit/3c9a7b889e4eeed301e71d67ed37246cc9097e63)), closes [#46](https://www.github.com/sentriz/cliphist/issues/46) 55 | * add version command ([3e91638](https://www.github.com/sentriz/cliphist/commit/3e91638630fc54f815ae025fa77e2472a770e91a)) 56 | * allow passing an id directly to decode ([a2ead3d](https://www.github.com/sentriz/cliphist/commit/a2ead3d83dd67ceb7189246ce428a21c559a449e)) 57 | * clear last entry if we get `clear` from CLIPBOARD_STATE ([5764b03](https://www.github.com/sentriz/cliphist/commit/5764b0345432b07eca49914e603a6fd2d1431a73)), closes [#58](https://www.github.com/sentriz/cliphist/issues/58) 58 | * **contrib:** add rofi script with support for displaying images ([#70](https://www.github.com/sentriz/cliphist/issues/70)) ([3da9a90](https://www.github.com/sentriz/cliphist/commit/3da9a90de9828018149bb11befd3c1d7f2ed44d5)) 59 | * **contrib:** speed up cliphist-rofi-img script and make compatible with 0.4 ([95c1936](https://www.github.com/sentriz/cliphist/commit/95c193604fce7c5ec094ff9bf1c62cc6f5395750)), closes [#71](https://www.github.com/sentriz/cliphist/issues/71) 60 | * don't store items >5MB ([594ca54](https://www.github.com/sentriz/cliphist/commit/594ca54b6c9d3363f7c59b95a40832d71bf8c5e5)), closes [#68](https://www.github.com/sentriz/cliphist/issues/68) 61 | * show image size and dimensions in preview ([dd3c5f0](https://www.github.com/sentriz/cliphist/commit/dd3c5f0248065d8f36c48445b3e68ffb6000ff86)) 62 | 63 | ## [0.4.0](https://www.github.com/sentriz/cliphist/compare/v0.3.1...v0.4.0) (2023-03-08) 64 | 65 | 66 | ### Features 67 | 68 | * add -max-items and -max-dedupe-search command line args ([df85b70](https://www.github.com/sentriz/cliphist/commit/df85b70a9033cb400ca8758192eb901f21718f04)), closes [#35](https://www.github.com/sentriz/cliphist/issues/35) 69 | * add "wipe" command ([c2e08d9](https://www.github.com/sentriz/cliphist/commit/c2e08d998c0724da37d179c8aa2356913241c35b)) 70 | * use tab as the id separator ([bf792ca](https://www.github.com/sentriz/cliphist/commit/bf792cab257db65be5d1287723353d380e9ecccc)) 71 | 72 | ### [0.3.1](https://www.github.com/sentriz/cliphist/compare/v0.3.0...v0.3.1) (2022-03-12) 73 | 74 | 75 | ### Bug Fixes 76 | 77 | * read write std io before opening db ([4a54efe](https://www.github.com/sentriz/cliphist/commit/4a54efe6fd027e2bef933d3f2d7270badae5d919)), closes [#26](https://www.github.com/sentriz/cliphist/issues/26) 78 | 79 | ## [0.3.0](https://www.github.com/sentriz/cliphist/compare/v0.2.0...v0.3.0) (2021-10-26) 80 | 81 | 82 | ### ⚠ BREAKING CHANGES 83 | 84 | * set delete commands to db `delete` / `delete-query` 85 | 86 | ### Features 87 | 88 | * don't ignore small inputs ([7cd236c](https://www.github.com/sentriz/cliphist/commit/7cd236ceeeab83bbd8c26baad230cee60807ded1)), closes [#17](https://www.github.com/sentriz/cliphist/issues/17) 89 | 90 | 91 | ### Code Refactoring 92 | 93 | * set delete commands to db `delete` / `delete-query` ([4e8c459](https://www.github.com/sentriz/cliphist/commit/4e8c45991456f3e69d7db3c0a5f799129acbaa71)) 94 | 95 | ## [0.2.0](https://www.github.com/sentriz/cliphist/compare/v0.1.0...v0.2.0) (2021-10-24) 96 | 97 | 98 | ### Features 99 | 100 | * add delete-stdin command ([db1ebf1](https://www.github.com/sentriz/cliphist/commit/db1ebf1e937c22d7dfbd51dd17854f9f282840e3)), closes [#18](https://www.github.com/sentriz/cliphist/issues/18) 101 | 102 | ## 0.1.0 (2021-09-17) 103 | 104 | 105 | ### Features 106 | 107 | * add LICENSE ([d6389f9](https://www.github.com/sentriz/cliphist/commit/d6389f951b3e70b52ac116d1015de5fed41ddba0)) 108 | * **ci:** setup release please ([6bd3aeb](https://www.github.com/sentriz/cliphist/commit/6bd3aeb4b5a8473097db788a341b002368821aee)) 109 | 110 | 111 | ### Bug Fixes 112 | 113 | * **ci:** disable errcheck ([79c5d6c](https://www.github.com/sentriz/cliphist/commit/79c5d6cfdf321a93e2cbd2f2645672c7335a7d1e)) 114 | -------------------------------------------------------------------------------- /cliphist.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bufio" 5 | "bytes" 6 | "encoding/binary" 7 | "errors" 8 | "flag" 9 | "fmt" 10 | "image" 11 | "io" 12 | "os" 13 | "path/filepath" 14 | "strconv" 15 | "strings" 16 | "time" 17 | 18 | _ "embed" 19 | _ "image/gif" 20 | _ "image/jpeg" 21 | _ "image/png" 22 | 23 | _ "golang.org/x/image/bmp" 24 | _ "golang.org/x/image/tiff" 25 | 26 | "github.com/rivo/uniseg" 27 | bolt "go.etcd.io/bbolt" 28 | "go.senan.xyz/flagconf" 29 | ) 30 | 31 | //go:embed version.txt 32 | var version string 33 | 34 | //nolint:errcheck 35 | func main() { 36 | flag.Usage = func() { 37 | fmt.Fprintf(flag.CommandLine.Output(), "usage:\n") 38 | fmt.Fprintf(flag.CommandLine.Output(), " $ %s \n", flag.CommandLine.Name()) 39 | fmt.Fprintf(flag.CommandLine.Output(), "options:\n") 40 | flag.VisitAll(func(f *flag.Flag) { 41 | fmt.Fprintf(flag.CommandLine.Output(), " -%s (default %s)\n", f.Name, f.DefValue) 42 | fmt.Fprintf(flag.CommandLine.Output(), " %s\n", f.Usage) 43 | }) 44 | } 45 | 46 | cacheHome, err := os.UserCacheDir() 47 | if err != nil { 48 | fmt.Fprintln(os.Stderr, err) 49 | os.Exit(1) 50 | } 51 | configHome, err := os.UserConfigDir() 52 | if err != nil { 53 | fmt.Fprintln(os.Stderr, err) 54 | os.Exit(1) 55 | } 56 | 57 | maxItems := flag.Uint64("max-items", 750, "maximum number of items to store") 58 | maxDedupeSearch := flag.Uint64("max-dedupe-search", 100, "maximum number of last items to look through when finding duplicates") 59 | minLength := flag.Uint("min-store-length", 0, "minimum number of characters to store") 60 | previewWidth := flag.Uint("preview-width", 100, "maximum number of characters to preview") 61 | dbPath := flag.String("db-path", filepath.Join(cacheHome, "cliphist", "db"), "path to db") 62 | configPath := flag.String("config-path", filepath.Join(configHome, "cliphist", "config"), "overwrite config path to use instead of cli flags") 63 | 64 | flag.Parse() 65 | flagconf.ParseEnv() 66 | flagconf.ParseConfig(*configPath) 67 | 68 | switch flag.Arg(0) { 69 | case "store": 70 | switch os.Getenv("CLIPBOARD_STATE") { // from man wl-clipboard 71 | case "sensitive": 72 | case "clear": 73 | err = deleteLast(*dbPath) 74 | default: 75 | err = store(*dbPath, os.Stdin, *maxDedupeSearch, *maxItems, *minLength) 76 | } 77 | case "list": 78 | err = list(*dbPath, os.Stdout, *previewWidth) 79 | case "decode": 80 | err = decode(*dbPath, os.Stdin, os.Stdout, flag.Arg(1)) 81 | case "delete-query": 82 | err = deleteQuery(*dbPath, flag.Arg(1)) 83 | case "delete": 84 | err = delete(*dbPath, os.Stdin) 85 | case "wipe": 86 | err = wipeAndCompact(*dbPath) 87 | case "version": 88 | fmt.Fprintf(flag.CommandLine.Output(), "%s\t%s\n", "version", strings.TrimSpace(version)) 89 | flag.VisitAll(func(f *flag.Flag) { 90 | fmt.Fprintf(flag.CommandLine.Output(), "%s\t%s\n", f.Name, f.Value) 91 | }) 92 | default: 93 | flag.Usage() 94 | os.Exit(1) 95 | } 96 | if err != nil { 97 | fmt.Fprintln(os.Stderr, err) 98 | os.Exit(1) 99 | } 100 | } 101 | 102 | func store(dbPath string, in io.Reader, maxDedupeSearch, maxItems uint64, minLength uint) error { 103 | input, err := io.ReadAll(in) 104 | if err != nil { 105 | return fmt.Errorf("read stdin: %w", err) 106 | } 107 | if len(input) > 5*1e6 { // don't store >5MB 108 | return nil 109 | } 110 | if int(minLength) > 0 && graphemeClusterCount(string(input)) < int(minLength) { 111 | return nil 112 | } 113 | 114 | db, err := initDB(dbPath) 115 | if err != nil { 116 | return fmt.Errorf("opening db: %w", err) 117 | } 118 | defer db.Close() 119 | 120 | if len(bytes.TrimSpace(input)) == 0 { 121 | return nil 122 | } 123 | tx, err := db.Begin(true) 124 | if err != nil { 125 | return fmt.Errorf("begin tx: %w", err) 126 | } 127 | defer tx.Rollback() //nolint:errcheck 128 | 129 | b := tx.Bucket([]byte(bucketKey)) 130 | 131 | if err := deduplicate(b, input, maxDedupeSearch); err != nil { 132 | return fmt.Errorf("deduplicating: %w", err) 133 | } 134 | id, err := b.NextSequence() 135 | if err != nil { 136 | return fmt.Errorf("getting next sequence: %w", err) 137 | } 138 | if err := b.Put(itob(id), input); err != nil { 139 | return fmt.Errorf("insert stdin: %w", err) 140 | } 141 | if err := trimLength(b, maxItems); err != nil { 142 | return fmt.Errorf("trimming length: %w", err) 143 | } 144 | 145 | if err := tx.Commit(); err != nil { 146 | return fmt.Errorf("commit tx: %w", err) 147 | } 148 | return nil 149 | } 150 | 151 | // trim the store's size to a number of max items. manually counting 152 | // seen items because we can't rely on sequence numbers when items can 153 | // be deleted when deduplicating 154 | func trimLength(b *bolt.Bucket, maxItems uint64) error { 155 | c := b.Cursor() 156 | var seen uint64 157 | for k, _ := c.Last(); k != nil; k, _ = c.Prev() { 158 | if seen < maxItems { 159 | seen++ 160 | continue 161 | } 162 | if err := b.Delete(k); err != nil { 163 | return fmt.Errorf("delete :%w", err) 164 | } 165 | seen++ 166 | } 167 | return nil 168 | } 169 | 170 | func deduplicate(b *bolt.Bucket, input []byte, maxDedupeSearch uint64) error { 171 | c := b.Cursor() 172 | var seen uint64 173 | for k, v := c.Last(); k != nil; k, v = c.Prev() { 174 | if seen > maxDedupeSearch { 175 | break 176 | } 177 | if !bytes.Equal(v, input) { 178 | seen++ 179 | continue 180 | } 181 | if err := b.Delete(k); err != nil { 182 | return fmt.Errorf("delete :%w", err) 183 | } 184 | seen++ 185 | } 186 | return nil 187 | } 188 | 189 | func list(dbPath string, out io.Writer, previewWidth uint) error { 190 | db, err := initDBReadOnly(dbPath) 191 | if err != nil { 192 | return fmt.Errorf("opening db: %w", err) 193 | } 194 | defer db.Close() 195 | 196 | tx, err := db.Begin(false) 197 | if err != nil { 198 | return fmt.Errorf("begin tx: %w", err) 199 | } 200 | defer tx.Rollback() //nolint:errcheck 201 | 202 | b := tx.Bucket([]byte(bucketKey)) 203 | c := b.Cursor() 204 | for k, v := c.Last(); k != nil; k, v = c.Prev() { 205 | fmt.Fprintln(out, preview(btoi(k), v, previewWidth)) 206 | } 207 | return nil 208 | } 209 | 210 | const fieldSep = "\t" 211 | 212 | func extractID(input string) (uint64, error) { 213 | idStr, _, _ := strings.Cut(input, fieldSep) 214 | if idStr == "" { 215 | return 0, fmt.Errorf("input not prefixed with id") 216 | } 217 | id, err := strconv.Atoi(idStr) 218 | if err != nil { 219 | return 0, fmt.Errorf("converting id: %w", err) 220 | } 221 | return uint64(id), nil 222 | } 223 | 224 | func decode(dbPath string, in io.Reader, out io.Writer, input string) error { 225 | if input == "" { 226 | inp, err := io.ReadAll(in) 227 | if err != nil { 228 | return fmt.Errorf("read stdin: %w", err) 229 | } 230 | input = string(inp) 231 | } 232 | id, err := extractID(input) 233 | if err != nil { 234 | return fmt.Errorf("extracting id: %w", err) 235 | } 236 | 237 | db, err := initDBReadOnly(dbPath) 238 | if err != nil { 239 | return fmt.Errorf("opening db: %w", err) 240 | } 241 | defer db.Close() 242 | 243 | tx, err := db.Begin(false) 244 | if err != nil { 245 | return fmt.Errorf("begin tx: %w", err) 246 | } 247 | defer tx.Rollback() //nolint:errcheck 248 | 249 | b := tx.Bucket([]byte(bucketKey)) 250 | v := b.Get(itob(id)) 251 | if v == nil { 252 | return fmt.Errorf("id %d not found", id) 253 | } 254 | 255 | if _, err := out.Write(v); err != nil { 256 | return fmt.Errorf("writing out: %w", err) 257 | } 258 | return nil 259 | } 260 | 261 | func deleteQuery(dbPath string, query string) error { 262 | if query == "" { 263 | return fmt.Errorf("please provide a query") 264 | } 265 | 266 | db, err := initDB(dbPath) 267 | if err != nil { 268 | return fmt.Errorf("opening db: %w", err) 269 | } 270 | defer db.Close() 271 | 272 | tx, err := db.Begin(true) 273 | if err != nil { 274 | return fmt.Errorf("begin tx: %w", err) 275 | } 276 | defer tx.Rollback() //nolint:errcheck 277 | 278 | b := tx.Bucket([]byte(bucketKey)) 279 | c := b.Cursor() 280 | for k, v := c.First(); k != nil; k, v = c.Next() { 281 | if bytes.Contains(v, []byte(query)) { 282 | _ = b.Delete(k) 283 | } 284 | } 285 | 286 | if err := tx.Commit(); err != nil { 287 | return fmt.Errorf("commit tx: %w", err) 288 | } 289 | return nil 290 | } 291 | 292 | func deleteLast(dbPath string) error { 293 | db, err := initDB(dbPath) 294 | if err != nil { 295 | return fmt.Errorf("opening db: %w", err) 296 | } 297 | defer db.Close() 298 | 299 | tx, err := db.Begin(true) 300 | if err != nil { 301 | return fmt.Errorf("begin tx: %w", err) 302 | } 303 | defer tx.Rollback() //nolint:errcheck 304 | 305 | b := tx.Bucket([]byte(bucketKey)) 306 | c := b.Cursor() 307 | k, _ := c.Last() 308 | _ = b.Delete(k) 309 | 310 | if err := tx.Commit(); err != nil { 311 | return fmt.Errorf("commit tx: %w", err) 312 | } 313 | return nil 314 | } 315 | 316 | func delete(dbPath string, in io.Reader) error { 317 | input, err := io.ReadAll(in) // drain stdin before opening and locking db 318 | if err != nil { 319 | return fmt.Errorf("read stdin: %w", err) 320 | } 321 | db, err := initDB(dbPath) 322 | if err != nil { 323 | return fmt.Errorf("opening db: %w", err) 324 | } 325 | defer db.Close() 326 | 327 | tx, err := db.Begin(true) 328 | if err != nil { 329 | return fmt.Errorf("begin tx: %w", err) 330 | } 331 | defer tx.Rollback() //nolint:errcheck 332 | 333 | for sc := bufio.NewScanner(bytes.NewReader(input)); sc.Scan(); { 334 | id, err := extractID(sc.Text()) 335 | if err != nil { 336 | return fmt.Errorf("extract id: %w", err) 337 | } 338 | b := tx.Bucket([]byte(bucketKey)) 339 | if err := b.Delete(itob(id)); err != nil { 340 | return fmt.Errorf("delete key: %w", err) 341 | } 342 | } 343 | 344 | if err := tx.Commit(); err != nil { 345 | return fmt.Errorf("commit tx: %w", err) 346 | } 347 | return nil 348 | } 349 | 350 | func wipeAndCompact(dbPath string) error { 351 | if err := wipe(dbPath); err != nil { 352 | return fmt.Errorf("wipe: %w", err) 353 | } 354 | if err := compactDB(dbPath); err != nil { 355 | return fmt.Errorf("compact: %w", err) 356 | } 357 | return nil 358 | } 359 | 360 | func wipe(dbPath string) error { 361 | db, err := initDB(dbPath) 362 | if err != nil { 363 | return fmt.Errorf("opening db: %w", err) 364 | } 365 | defer db.Close() 366 | 367 | tx, err := db.Begin(true) 368 | if err != nil { 369 | return fmt.Errorf("begin tx: %w", err) 370 | } 371 | defer tx.Rollback() //nolint:errcheck 372 | 373 | b := tx.Bucket([]byte(bucketKey)) 374 | c := b.Cursor() 375 | for k, _ := c.First(); k != nil; k, _ = c.Next() { 376 | _ = b.Delete(k) 377 | } 378 | 379 | if err := tx.Commit(); err != nil { 380 | return fmt.Errorf("commit tx: %w", err) 381 | } 382 | return nil 383 | } 384 | 385 | const bucketKey = "b" 386 | 387 | func initDB(path string) (*bolt.DB, error) { return initDBOption(path, false) } 388 | func initDBReadOnly(path string) (*bolt.DB, error) { return initDBOption(path, true) } 389 | 390 | func initDBOption(path string, ro bool) (*bolt.DB, error) { 391 | if err := os.MkdirAll(filepath.Dir(path), 0700); err != nil { 392 | return nil, fmt.Errorf("create cache dir: %w", err) 393 | } 394 | 395 | // https://github.com/etcd-io/bbolt/issues/98 396 | if ro { 397 | if _, err := os.Stat(path); errors.Is(err, os.ErrNotExist) { 398 | return nil, errors.New("please store something first") 399 | } 400 | } 401 | 402 | db, err := bolt.Open(path, 0644, &bolt.Options{ 403 | ReadOnly: ro, 404 | Timeout: 1 * time.Second, 405 | }) 406 | if err != nil { 407 | return nil, fmt.Errorf("open db: %w", err) 408 | } 409 | if db.IsReadOnly() { 410 | return db, nil 411 | } 412 | err = db.Update(func(tx *bolt.Tx) error { 413 | _, err := tx.CreateBucketIfNotExists([]byte(bucketKey)) 414 | return err 415 | }) 416 | if err != nil { 417 | return nil, fmt.Errorf("init bucket: %w", err) 418 | } 419 | return db, nil 420 | } 421 | 422 | func compactDB(path string) error { 423 | srcDB, err := bolt.Open(path, 0644, &bolt.Options{ 424 | ReadOnly: true, 425 | Timeout: 1 * time.Second, 426 | }) 427 | if err != nil { 428 | return fmt.Errorf("open source db: %w", err) 429 | } 430 | defer srcDB.Close() 431 | 432 | tmpPath := path + ".tmp" 433 | dstDB, err := bolt.Open(tmpPath, 0644, &bolt.Options{ 434 | Timeout: 1 * time.Second, 435 | }) 436 | if err != nil { 437 | return fmt.Errorf("open destination db: %w", err) 438 | } 439 | defer dstDB.Close() 440 | 441 | if err := bolt.Compact(dstDB, srcDB, 0); err != nil { 442 | os.Remove(tmpPath) 443 | return fmt.Errorf("compact db: %w", err) 444 | } 445 | 446 | if err := srcDB.Close(); err != nil { 447 | return fmt.Errorf("close source db: %w", err) 448 | } 449 | if err := dstDB.Close(); err != nil { 450 | return fmt.Errorf("close destination db: %w", err) 451 | } 452 | 453 | if err := os.Rename(tmpPath, path); err != nil { 454 | return fmt.Errorf("replace db: %w", err) 455 | } 456 | return nil 457 | } 458 | 459 | func preview(index uint64, data []byte, width uint) string { 460 | if config, format, err := image.DecodeConfig(bytes.NewReader(data)); err == nil { 461 | return fmt.Sprintf("%d%s[[ binary data %s %s %dx%d ]]", 462 | index, fieldSep, sizeStr(len(data)), format, config.Width, config.Height) 463 | } 464 | prev := string(data) 465 | prev = strings.TrimSpace(prev) 466 | prev = strings.Join(strings.Fields(prev), " ") 467 | prev = trunc(prev, int(width), "…") 468 | return fmt.Sprintf("%d%s%s", index, fieldSep, prev) 469 | } 470 | 471 | func trunc(in string, max int, ellip string) string { 472 | runes := []rune(in) 473 | if len(runes) > max { 474 | return string(runes[:max]) + ellip 475 | } 476 | return in 477 | } 478 | 479 | func graphemeClusterCount(str string) int { 480 | return uniseg.GraphemeClusterCount(str) 481 | } 482 | 483 | func min(a, b int) int { //nolint:unused // we still support go1.19 484 | if a < b { 485 | return a 486 | } 487 | return b 488 | } 489 | 490 | func itob(v uint64) []byte { 491 | b := make([]byte, 8) 492 | binary.BigEndian.PutUint64(b, v) 493 | return b 494 | } 495 | 496 | func btoi(v []byte) uint64 { 497 | return binary.BigEndian.Uint64(v) 498 | } 499 | 500 | func sizeStr(size int) string { 501 | units := []string{"B", "KiB", "MiB"} 502 | 503 | var i int 504 | fsize := float64(size) 505 | for fsize >= 1024 && i < len(units)-1 { 506 | fsize /= 1024 507 | i++ 508 | } 509 | return fmt.Sprintf("%.0f %s", fsize, units[i]) 510 | } 511 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------