[ { "path": ".build.yml", "content": "image: ubuntu/lts\npackages:\n - meson\n - ninja-build\n - autoconf\n - automake\n - build-essential\n - libpango1.0-dev\n - libstartup-notification0-dev\n - libxcb-ewmh-dev\n - libxcb-icccm4-dev\n - libxcb-randr0-dev\n - libxcb-util0-dev\n - libxcb-xinerama0-dev\n - libxcb-xkb-dev\n - libxcb-xrm-dev\n - libxcb-cursor-dev\n - libxcb-imdkit-dev\n - libxcb-keysyms1\n - libxkbcommon-dev\n - libxkbcommon-dev\n - libxkbcommon-x11-dev\n - libgdk-pixbuf2.0-dev\n - ninja-build\n - pandoc\n - check\n - flex\n - bison\n - libglib2.0-dev-bin\n - doxygen\nsources:\n - https://sr.ht/~qball/rofi/\ntasks:\n - setup: |\n cd rofi\n meson setup builddir . -Db_lto=true\n - build: |\n ninja -C rofi/builddir\n - test: |\n ninja -C rofi/builddir test\n - doxygen: |\n ninja -C rofi/builddir/ doc/html > doxygen.log 2>&1\n if [ $(grep -c warnings doxygen.log) -gt 0 ]; then exit 1; fi \n - dist: |\n ninja -C rofi/builddir dist\nartifacts:\n - rofi/builddir/meson-dist/rofi-1.7.8-dev.tar.xz\n" }, { "path": ".clang-tidy", "content": "Checks: -clang-analyzer-optin.core.EnumCastOutOfRange\n" }, { "path": ".gitattributes", "content": ".build.yml export-ignore\n.gitattributes export-ignore\n.gitignore export-ignore\n.mailmap export-ignore\n.github export-ignore\n.gitlab-ci.yml export-ignore\n.gitmodules export-ignore\n.travis.yml export-ignore\nreleasenotes export-ignore\ndoc/*.png export-ignore\ndoc/help-output.txt export-ignore\ndoc/sizing.svg export-ignore\ndoc/Notes export-ignore\ndoc/old-theme-convert-output.rasi export-ignore\ndoc/test_xr.txt export-ignore\ndoc/create_screenshot.sh export-ignore\nmkdocs export-ignore\nscript/*.jpg export-ignore\n" }, { "path": ".github/CONTRIBUTING.md", "content": "When reporting bugs keep in mind that the people working on it do this unpaid,\nin their free time and as a hobby. So be polite and helpful. Reports that\ndemand, contain insults to this or other projects, or have a general unfriendly\ntone will be closed without discussion. Everybody has it own way of working;\nWhat might be the norm for you, might not be for others. Therefore be verbose in\nyour description.\n\n**The issue tracker is for bugs only.**\n\nThis is an attempt to keep the issue tracker clean and searchable.\n\nQuestions or discussions about new features belong on\n[GITHUB Discussions](https://github.com/davatorium/rofi/discussions) or\n[FORUM](https://reddit.com/r/qtools/),\n[IRC](https://webchat.freenode.net/?channels=#rofi), frequently asked questions\nwill be added to the [F.A.Q](https://github.com/DaveDavenport/rofi/wiki#faq) on\nthe [wiki](https://github.com/DaveDavenport/rofi/wiki).\n\nQuestions filled in on the bug tracker will be marked `question`, locked and\nclosed.\n\nIt is preferred to have feature requests discussed via\n[GITHUB Discussions](https://github.com/davatorium/rofi/discussions) or\n[FORUM](https://reddit.com/r/qtools/) or\n[IRC](https://webchat.freenode.net/?channels=#rofi) first.\n\n# Creating a bug report\n\nPlease write your bug reports in clear English.\n\nBefore creating a bug report:\n\n* Update to the latest version. Check if problem still exists.\n* Check existing bug reports, see if it is already reported.\n* Read the documentation. Make sure the behaviour you are seeing is a bug.\n\nWhen reporting bugs include the following information:\n\n* Rofi version. rofi -v\n* Rofi configuration. rofi -help (in a [gist](https://gist.github.com/))\n* Steps to reproduce.\n* What behaviour you see.\n* What behaviour you expect to see.\n* A proper title for others to search for.\n* Be exact.\n\nWhen adding comments to an issue make sure:\n\n* It is relevant to the issue.\n* It contributes to solving the issue.\n* Use :+1: :-1: emojis instead of replying 'me too' or 'I also have this.'\n* Do **NOT** ask for an update. Asking does not contribute to solving the issue\n and just annoys people with a notification. The answer is already available;\n if there is an update it will be linked/mentioned in the issue, otherwise\n there is no update.\n\nIssue high-jacking, e.g. adding a request/issue to an existing issue, is very\ndisruptive.\nPlease create a new issue, if it is similar it will be marked duplicate.\n\n# Creating a feature request\n\nBefore creating a feature request:\n\n* First check the *next* branch, to see if the feature has already been\n implemented.\n* Check existing reports, see if it is already requested.\n\nWhen reporting a feature request include the following information:\n\n* Rofi version and other information. (rofi -info)\n* A clear description of the feature you want added.\n* A use-case for the feature.\n\nIf possible try to explain how you would expect to use feature.\nFor example, should it be a configuration option or a hot-key.\n\nRequesting a feature is no guarantee it will be added.\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.yml", "content": "name: Bug Report\ndescription: Report a problem in Rofi\nlabels: [bug]\ntitle: \"[BUG] \"\nbody:\n - type: markdown\n attributes:\n value: |\n First read the\n [guidelines](https://github.com/DaveDavenport/rofi/blob/next/.github/CONTRIBUTING.md)!\n This is not optional for any report. People must be able to understand\n the full context of the report when reading it, at any time.\n\n If you feel like you “it is simple and requires no explanation”, please\n consider you’re wrong and still fill the full report. What is clear to\n you might not be clear to somebody else. Any report missing required\n informations will be labeled as “Incomplete Report - Please follow the\n guidelines” and will be closed. If you ask a question, enter dummy\n information in required fields to get past the checks or in general\n completely ignore the guidelines, the issue will be closed and locked\n as spam. This includes filling in 'Distro X defaults', we don't know\n and cannot keep track of what each distribution ships as a default.\n\n If you are unsure, please use the\n [discussion](https://github.com/davatorium/rofi/discussions) forum\n first. It is easy to upgrade a question to an issue in github.\n\n If you report problems with speed in rofi, please attach a [timing\n trace](https://github.com/davatorium/rofi/blob/next/doc/rofi-debugging.5.markdown#timing-traces).\n\n If you have a problem that only occurs when launching rofi from a keybinding.\n First check that the environment the keybinding passes to rofi is correct.\n\n - type: input\n attributes:\n label: \"Rofi version (rofi -v or git commit in case of build issue)\"\n placeholder: \"Version: 1.7.5\"\n validations:\n required: true\n - type: input\n attributes:\n label: \"Configuration\"\n description: |\n Please use https://gist.github.com and include output of `rofi -info` and `rofi -dump-config`.\n Anything that is not a link to valid output, will not be accepted.\n placeholder: \"Gist URL\"\n validations:\n required: true\n - type: input\n attributes:\n label: \"Theme\"\n description: |\n Please use https://gist.github.com and include output of `rofi -dump-theme`.\n Anything that is not a link to valid output, will not be accepted.\n placeholder: \"Gist URL\"\n validations:\n required: true\n - type: input\n attributes:\n label: \"Timing report\"\n description: |\n Please use https://gist.github.com and include output of your command with G_MESSAGES_DEBUG=Timings set.\n placeholder: \"Gist URL\"\n validations:\n required: false\n - type: input\n attributes:\n label: \"Launch command\"\n placeholder: \"rofi -show drun\"\n validations:\n required: true\n\n - type: textarea\n attributes:\n label: \"Step to reproduce\"\n placeholder: |\n * Step 1\n * Step 2\n * ...\n validations:\n required: true\n\n - type: textarea\n attributes:\n label: \"Expected behavior\"\n description: \"Describe the behavior you expect. May include logs, images, or videos.\"\n validations:\n required: true\n - type: textarea\n attributes:\n label: \"Actual behavior\"\n validations:\n required: true\n - type: textarea\n attributes:\n label: \"Additional information\"\n validations:\n required: false\n - type: checkboxes\n id: latestversion\n attributes:\n label: I've checked if the issue exists in the latest stable release\n description: I confirm that I verified the issue still exists in the latest stable release.\n options:\n - label: \"Yes, I have checked the problem exists in the latest stable version\"\n required: false\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false\ncontact_links:\n - name: discussion forum\n url: https://github.com/davatorium/rofi/discussions\n about: Please ask and answer questions here.\n - name: Rofi IRC channel\n url: https://web.libera.chat/?channels=#rofi\n about: Please ask and answer question in real time here.\n" }, { "path": ".github/ISSUE_TEMPLATE/documentation_report.yml", "content": "name: Documentation Bug Report\ndescription: Report a problem in Rofi Documentation\nlabels: [Documentation]\ntitle: \"[Doc] \"\nbody:\n\n - type: markdown\n attributes:\n value: |\n First read the\n [guidelines](https://github.com/DaveDavenport/rofi/blob/next/.github/CONTRIBUTING.md)!\n This is not optional for any report. People must be able to understand\n the full context of the report when reading it, at any time.\n\n If you feel like you “it is simple and requires no explanation”, please\n consider you’re wrong and still fill the full report. Any report\n missing required informations will be labeled as “Incomplete Report -\n Please follow the guidelines” and will be closed. If you ask a\n question, enter dummy information in required fields to get passed the\n checks or in general completely ignore the guidelines, the issue will\n be closed and locked as spam.\n\n If you are unsure, please use the\n [discussion](https://github.com/davatorium/rofi/discussions) forum\n first. It is easy to upgrade a question to an issue in github.\n\n **Please do not submit reports related to wayland, see\n [here](https://github.com/DaveDavenport/rofi/wiki/Wayland) for more\n information.**\n\n - type: input\n attributes:\n label: \"Rofi version (rofi -v)\"\n placeholder: \"Version: 1.7.5\"\n validations:\n required: true\n - type: input\n attributes:\n label: \"URL\"\n description: \"Please provide a link to the relevant documentation.\"\n placeholder: \"link to page on https://davatorium.github.io/rofi/ or file on https://github.com/davatorium/rofi/\"\n validations:\n required: true\n\n - type: textarea\n attributes:\n label: \"Explain the issue with the documentation, please be verbose.\"\n placeholder: |\n * What am I trying to achieve\n ..\n * What instructions are unclear, wrong or missing\n ..\n * Suggestions for improving the current documentation\n ..\n validations:\n required: true\n - type: textarea\n attributes:\n label: \"Optional fixed text\"\n description: \"Suggested new and or improved text for documentation.\"\n validations:\n required: false\n - type: checkboxes\n id: wayland\n attributes:\n label: Using wayland display server protocol\n description: I have checked and confirm that my issue is not related to running rofi using wayland as display server protocol. See [here](https://github.com/DaveDavenport/rofi/wiki/Wayland) for more information.\n options:\n - label: \"No, my documentation issue is not about running rofi using the wayland display server protocol\"\n required: true\n - type: checkboxes\n id: latestversion\n attributes:\n label: I've checked if the issue exists in the latest stable release\n description: I confirm that I verified the issue still exists in the latest stable release. \n options:\n - label: \"Yes, I have checked the problem exists in the latest stable version\"\n required: false\n \n\n\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.yml", "content": "name: Feature Request\ndescription: It'd be cool if rofi did/had/would...\nlabels: Feature Request\ntitle: \"[REQUEST] \"\nbody:\n\n - type: markdown\n attributes:\n value: |\n First read the [guidelines](https://github.com/DaveDavenport/rofi/blob/next/.github/CONTRIBUTING.md)! This is not optional for any report/question. People must be able to understand the full context of the report when reading it, at any time.\n\n If you feel like you “just have a simple question”, please consider you’re wrong and still fill the full report. Any report missing these informations will be labeled as “Incomplete Report - Please follow the guidelines” and may not be answered in a timely fashion.\n\n If you are unsure, please use the [discussion](https://github.com/davatorium/rofi/discussions) forum first. It is easy to upgrade a question to an issue in github.\n\n **Requesting a feature is no guarantee it will be added.**\n\n - type: checkboxes\n id: before-feature-request\n attributes:\n label: Before opening a feature request\n options:\n - label: I checked the *next* branch to see if the feature has already been implemented\n required: true\n - label: I searched existing reports to see if it is already requested.\n required: true\n - type: textarea\n attributes:\n label: \"What is the user problem or growth opportunity you want to see solved?\"\n validations:\n required: true\n - type: textarea\n attributes:\n label: \"How do you know that this problem exists today? Why is this important?\"\n validations:\n required: true\n - type: textarea\n attributes:\n label: \"Who will benefit from it?\"\n validations:\n required: true\n - type: input\n attributes:\n label: \"Rofi version (rofi -v)\"\n placeholder: \"Version: 1.6.0\"\n validations:\n required: true\n - type: input\n attributes:\n label: \"Configuration & Information\"\n description: \"Please use https://gist.github.com and include output of `rofi -info`, `rofi -dump-config` and `rofi -dump-theme`.\"\n placeholder: \"Gist URL\"\n validations:\n required: true\n - type: textarea\n attributes:\n label: \"Additional information\"\n validations:\n required: false\n\n" }, { "path": ".github/actions/doxycheck/action.yml", "content": "name: Doxygen Check\ndescription: Checks for Doxygen warnings\n\nruns:\n using: composite\n steps:\n - id: doxy\n run: ninja -C builddir doc/html > builddir/doxygen.log 2>&1\n shell: bash\n - id: check\n run: |\n if [[ \"$(grep -c warning: builddir/doxygen.log)\" != 0 ]]; then\n echo\n echo Doxygen warnings found:\n grep warning builddir/doxygen.log\n echo\n\n exit 1\n fi\n\n python ./doxy-coverage/doxy-coverage.py builddir/doc/html/xml/\n shell: bash\n" }, { "path": ".github/actions/meson/action.yml", "content": "name: Meson Build\ndescription: Builds Rofi using Meson\n\ninputs:\n cc:\n description: Compiler to use\n required: true\n xcb:\n description: Enable xcb backend\n default: enabled\n wayland:\n description: Enable wayland backend\n default: enabled\n\nruns:\n using: composite\n steps:\n - id: pip\n run: pip install meson ninja\n shell: bash\n - id: setup\n run: meson setup builddir -Dxcb=${{ inputs.xcb }} -Dwayland=${{ inputs.wayland }}\n shell: bash\n env:\n CC: ${{ inputs.cc }}\n - id: build\n run: ninja -C builddir\n shell: bash\n - id: test\n run: ninja -C builddir test\n shell: bash\n" }, { "path": ".github/actions/release/action.yml", "content": "name: Upload dist\ndescription: Create distribution file and upload to release\n\nruns:\n using: composite\n steps:\n - id: dist\n run: meson dist -C builddir --include-subprojects --formats xztar,gztar --no-tests\n shell: bash\n - id: upload\n uses: actions/upload-artifact@v4\n with:\n name: release_tarballs-${{ github.ref_name }}\n path: |\n builddir/meson-dist/*.tar.xz\n builddir/meson-dist/*.tar.gz\n - id: create_release\n uses: softprops/action-gh-release@v2\n with:\n draft: true\n files: |\n builddir/meson-dist/*.tar.xz\n builddir/meson-dist/*.tar.gz\n" }, { "path": ".github/actions/setup/action.yml", "content": "name: CI Build Setup\ndescription: Sets up build dependencies\n\ninputs:\n xcb:\n description: Install xcb dependencies\n default: 'true'\n wayland:\n description: Install wayland dependencies\n default: 'true'\n\nruns:\n using: composite\n steps:\n - id: python\n uses: actions/setup-python@v4\n with:\n python-version: '3.x'\n - id: apt\n run: |\n sudo apt-get update\n sudo apt-get install -y \\\n discount \\\n doxygen \\\n fluxbox \\\n gdb \\\n graphviz \\\n jq \\\n lcov \\\n libpango1.0-dev \\\n libxkbcommon-dev \\\n libxkbcommon-dev \\\n libxkbcommon-x11-dev \\\n libgdk-pixbuf-2.0-dev \\\n ninja-build \\\n pandoc \\\n python3-pip \\\n python3-setuptools \\\n python3-wheel \\\n texi2html \\\n texinfo \\\n xdotool \\\n xfonts-base \\\n xterm \\\n xutils-dev\n shell: bash\n - id: doxy\n run: git clone https://github.com/davatorium/doxy-coverage\n shell: bash\n - id: apt-wayland\n if: ${{ inputs.wayland == 'true' }}\n run: |\n sudo apt-get install -y \\\n libwayland-dev \\\n wayland-protocols\n shell: bash\n - id: apt-xcb\n if: ${{ inputs.xcb == 'true' }}\n run: |\n sudo apt-get install -y \\\n libstartup-notification0-dev \\\n libxcb-ewmh-dev \\\n libxcb-icccm4-dev \\\n libxcb-randr0-dev \\\n libxcb-util0-dev \\\n libxcb-xinerama0-dev \\\n libxcb-xkb-dev \\\n libxcb-xrm-dev \\\n libxcb-cursor-dev \\\n libxcb-imdkit-dev\n shell: bash\n - id: check\n run: |\n curl -L https://github.com/libcheck/check/releases/download/0.15.2/check-0.15.2.tar.gz | tar xzf -\n cd check-0.15.2\n ./configure\n make\n sudo make install\n sudo ldconfig\n shell: bash\n" }, { "path": ".github/pull_request_template.md", "content": "> Please follow these steps before submitting your PR:\n>\n> - [ ] This PR targets the `next` branch and not `master`\n> - [ ] If your PR is a work in progress, include [WIP] in its title\n> - [ ] Its commits' summaries are reasonably descriptive\n> - [ ] You've described what this PR addresses below\n> - [ ] You've included links to relevant issues, if any with `#issue_num`\n> - [ ] You've deleted this template\n>\n> Thank you for contributing to rofi! <3\n\nYour description here...\n" }, { "path": ".github/workflows/build.yml", "content": "name: CI Build\n\non:\n push:\n branches:\n - next\n paths-ignore:\n - \"**.md\"\n - \"**.markdown\"\n - \"**.rasi\"\n pull_request:\n paths-ignore:\n - \"**.md\"\n - \"**.markdown\"\n - \"**.rasi\"\n\njobs:\n build-gcc:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n with:\n submodules: recursive\n - uses: ./.github/actions/setup\n - uses: ./.github/actions/meson\n with:\n cc: gcc\n - uses: ./.github/actions/doxycheck\n build-clang:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n with:\n submodules: recursive\n - uses: ./.github/actions/setup\n - uses: ./.github/actions/meson\n with:\n cc: clang\n build-gcc-wayland-only:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n with:\n submodules: recursive\n - uses: ./.github/actions/setup\n with:\n xcb: false\n - uses: ./.github/actions/meson\n with:\n cc: gcc\n xcb: disabled\n build-gcc-xcb-only:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: recursive\n - uses: ./.github/actions/setup\n with:\n wayland: false\n - uses: ./.github/actions/meson\n with:\n cc: gcc\n wayland: disabled\n" }, { "path": ".github/workflows/codeql.yml", "content": "name: \"CodeQL\"\n\non:\n push:\n branches: [ 'next', 'master' ]\n pull_request:\n # The branches below must be a subset of the branches above\n branches: [ 'next' ]\n schedule:\n - cron: '59 13 * * 3'\n\njobs:\n analyze:\n name: Analyze\n runs-on: ubuntu-latest\n permissions:\n actions: read\n contents: read\n security-events: write\n\n strategy:\n fail-fast: false\n matrix:\n language: [ 'cpp' ]\n # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]\n # Use only 'java' to analyze code written in Java, Kotlin or both\n # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both\n # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v3\n with:\n submodules: recursive\n\n - uses: ./.github/actions/setup\n\n # Initializes the CodeQL tools for scanning.\n - name: Initialize CodeQL\n uses: github/codeql-action/init@v3\n with:\n languages: ${{ matrix.language }}\n # If you wish to specify custom queries, you can do so here or in a config file.\n # By default, queries listed here will override any specified in a config file.\n # Prefix the list here with \"+\" to use these queries and those in the config file.\n\n # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs\n # queries: security-extended,security-and-quality\n\n - uses: ./.github/actions/meson\n with:\n cc: gcc\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@v3\n with:\n category: \"/language:${{matrix.language}}\"\n" }, { "path": ".github/workflows/lock.yml", "content": "name: 'Lock Threads'\n\non:\n schedule:\n - cron: '0 0 * * *'\n workflow_dispatch:\n\npermissions:\n issues: write\n pull-requests: write\n discussions: write\n\nconcurrency:\n group: lock-threads\n\njobs:\n action:\n runs-on: ubuntu-latest\n steps:\n - uses: dessant/lock-threads@v5\n with:\n process-only: 'issues'\n github-token: ${{ github.token }}\n issue-inactive-days: '31'\n exclude-issue-created-before: ''\n exclude-issue-created-after: ''\n exclude-issue-created-between: ''\n exclude-issue-closed-before: ''\n exclude-issue-closed-after: ''\n exclude-issue-closed-between: ''\n include-any-issue-labels: ''\n include-all-issue-labels: ''\n exclude-any-issue-labels: ''\n add-issue-labels: ''\n remove-issue-labels: ''\n issue-comment: >\n This pull request has been automatically locked since there\n has not been any recent activity after it was closed.\n Please open a new issue for related bugs.\n issue-lock-reason: 'resolved'\n log-output: false\n" }, { "path": ".github/workflows/main.yml", "content": "on:\n issues:\n types: [opened, edited]\n\njobs:\n auto_close_issues:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout\n uses: actions/checkout@v1\n\n - name: Automatically close issues that don't follow the issue template\n uses: davatorium/auto-close-issues@v1.0.4\n with:\n github-token: ${{ secrets.GITHUB_TOKEN }}\n issue-close-message: \"@${issue.user.login}: hello! :wave:\\n\\nThis issue is being automatically closed because it does not follow the issue template.\" # optional property\n closed-issues-label: \"Incomplete Report - Please follow the guidelines\" # optional property\n" }, { "path": ".github/workflows/mkdocs.yml", "content": "name: Publish docs via GitHub Pages\non:\n push:\n branches:\n - sphinx\n - next\n\njobs:\n build:\n name: Deploy docs\n runs-on: ubuntu-latest\n steps:\n - name: Checkout master\n uses: actions/checkout@v1\n\n - name: Deploy docs\n uses: mhausenblas/mkdocs-deploy-gh-pages@master\n env:\n CONFIG_FILE: mkdocs/mkdocs.yml \n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n" }, { "path": ".github/workflows/publish-release.yml", "content": "name: Publish release\n\non:\n push:\n tags:\n - '*'\n\njobs:\n publish-tarball:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v2\n with:\n submodules: recursive\n - uses: ./.github/actions/setup\n - uses: ./.github/actions/meson\n with:\n cc: gcc\n - uses: ./.github/actions/release\n" }, { "path": ".gitignore", "content": "/build*/\n/.cache/\n/.vscode/\n\n# I want to ignore log files\n*.log\n\n# Core files should never be checked in\ncore\n\n# ignore patches too, the code is either checked in or branch.\n*.patch*\n\n# backup files\n*.swp\n*.*~\n*.unc-backup~\n*.unc-backup.md5~\n" }, { "path": ".gitlab-ci.yml", "content": "before_script:\n - apt-get update\n - apt-get install --force-yes -y software-properties-common apt-transport-https\n - add-apt-repository -y 'deb http://debian.jpleau.ca/ jessie-backports main contrib non-free'\n - apt-get update -qq\n - apt-get install --force-yes -y autoconf automake make libx11-dev libpango1.0-dev libcairo2-dev libstartup-notification0-dev libxcb-icccm4-dev libxcb-util0-dev libxcb-xinerama0-dev libxcb-xkb-dev libx11-xcb-dev\n - apt-get install --force-yes -y libxcb1-dev xvfb discount xdotool fluxbox libxkbcommon-dev libxkbcommon-x11-dev libxcb-ewmh-dev xutils-dev libtool lcov libxcb-randr0-dev doxygen python flex bison librsvg2-dev texinfo \n - git clone --recursive https://github.com/Airblader/xcb-util-xrm.git\n - cd xcb-util-xrm\n - ./autogen.sh --prefix=/usr\n - make\n - sudo make install\n - cd -\n - git clone https://github.com/libcheck/check/ -b 0.11.0\n - cd check\n - autoreconf -i\n - TEX=\"false\" ./configure --prefix=/usr/\n - make\n - sudo make install\n - cd -\n - git clone https://github.com/alobbs/doxy-coverage\n\nbuild-rofi:\n script:\n - git submodule update --init\n - autoreconf -i\n - ./configure --enable-gcov\n - make\n - make check\n - make distcheck\n - make coverage\n - make doxy\n - python2 doxy-coverage/doxy-coverage.py doc/html/xml/\n artifacts:\n expire_in: 2 weeks\n paths:\n - coverage\n - doc/html\n" }, { "path": ".gitmodules", "content": "[submodule \"libgwater\"]\n\tpath = subprojects/libgwater\n\turl = https://github.com/sardemff7/libgwater\n[submodule \"libnkutils\"]\n\tpath = subprojects/libnkutils\n\turl = https://github.com/sardemff7/libnkutils\n" }, { "path": ".mailmap", "content": "Morgane Glidic \n" }, { "path": "AUTHORS", "content": "Aaron Ash\nAdrià Farrés\nAnton Löfgren\nAvatar\nbendem\nBenjamin Cremer\nBenjamin R. Haskell\nBruno Braga\nBuglloc\nChris Salzberg\ndaemoni\nDan Beste\nDaniel Hahler\nDanteFireX\nDave Davenport\nDeiwin Sarjas\nDimitar Yordanov\nEdwin Pujols\neigengrau\nEric Engeström\nFangrui Song\nfice-t\nFlorian Franzen\nGabriel Holodak\nGareth Poole\nGeorgios Bitzes\nGreg Fitzgerald\nGuy Hughes\nHexchain Tong\nIan Remmler\nJames Vaughan\nJason Pleau\nJasper Lievisse Adriaanse\nKlemens Schölhorn\nkoppa\nlbonn\nMarcin Sedlak\nmarduk\nMichael Vetter\nMoritz Maxeiner\nNick87720z\nNiklas Haas\nN. Izumi\nPaulo Flabiano Smorigo\nPeter Cannici\nqedi\nMorgane Glidic\nRasmus Steinke\nRaZ0rr-Two\nRoomcays\nseanpringle\nSebastian Reuße\nSimon Hanna\nStanislav Seletskiy\nThomas Adam\nThorsten Wißmann\nTilman Blumenbach\nTobias Kortkamp\nTom Hinton\nTonCherAmi\nvimeitor\nWieland Hoffmann\nYaroslav\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at qball@gmpclient.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" }, { "path": "CONFIG.md", "content": "> This page does not describe all of **ROFI**'s configuration options, just the\n> most common usecase. For the full configuration options, check the manpages.\n\n
\n\n## Where does the configuration live\n\nRofi's configurations, custom themes live in `${XDG_CONFIG_HOME}/rofi/`, on\nmost systems this is `~/.config/rofi/`.\n\nThe name of the main configuration file is `config.rasi`. (`~/.config/rofi/config.rasi`).\n\n## Create an empty configuration file\n\nOpen `~/.config/rofi/config.rasi` in your favorite text editor and add the\nfollowing block:\n\n```css\nconfiguration {\n\n}\n```\n\nYou can now set the options in the `configuration` block.\n\n## Create a configuration file from current setup\n\nIf you do not want to start from scratch, or want to migrate from older\nconfiguration format, you can get tell rofi to dumps it configuration:\n\n```bash\nrofi -dump-config > ~/.config/rofi/config.rasi\n```\n\nThis will have all the possible settings and their current value.\nIf a value is the default value, the entry will be commented.\n\nFor example:\n\n```css\nconfiguration { \n/* modes: \"window,run,ssh,drun\";*/\n/* font: \"mono 12\";*/\n/* location: 0;*/\n/* yoffset: 0;*/\n/* xoffset: 0;*/\n/* fixed-num-lines: true;*/\n... cut ...\n/* ml-row-down: \"ScrollDown\";*/ \n/* me-select-entry: \"MousePrimary\";*/ \n/* me-accept-entry: \"MouseDPrimary\";*/ \n/* me-accept-custom: \"Control+MouseDPrimary\";*/ \n}\n```\n\nTo create a copy of the current theme, you can run:\n\n```bash\nrofi -dump-theme > ~/.config/rofi/current.rasi\n```\n\n## Configuration file format\n\n### Encoding\n\nThe encoding of the file is utf-8. Both Unix (`\\n`) and windows (`\\r\\n`)\nnewlines format are supported. But Unix is preferred.\n\n### Comments\n\nC and C++ file comments are supported.\n\n- Anything after `//` and before a newline is considered a comment.\n- Everything between `/*` and `*/` is a comment.\n\nComments can be nested and the C comments can be inline.\n\nThe following is valid:\n\n```css\n// Magic comment.\nproperty: /* comment */ value;\n```\n\nHowever, this is not:\n\n```css\nprop/*comment*/erty: value;\n```\n\n### White space\n\nWhite space and newlines, like comments, are ignored by the parser.\n\nThis:\n\n```css\nproperty: name;\n```\n\nIs identical to:\n\n```css\n property :\nname\n\n;\n```\n\n### Data types\n\n**ROFI**'s configuration supports several data formats:\n\n#### String\n\nA string is always surrounded by double quotes (`\"`). Between the quotes there\ncan be any printable character.\n\nFor example:\n\n```css\n\n ml-row-down: \"ScrollDown\";\n```\n\n#### Number\n\nAn integer may contain any full number.\n\nFor example:\n\n```css\neh: 2; \n```\n\n#### Boolean\n\nBoolean value is either `true` or `false`. This is case-sensitive.\n\nFor example:\n\n```css\nshow-icons: true;\n```\n\nThis is equal to the `-show-icons` option on the commandline, and `show-icons:\nfalse;` is equal to `-no-show-icons`.\n\n#### List\n\nThis is not supported by the old configuration system, but can be used in the\n**rasi** format.\n\nA list starts with a '[' and ends with a ']'. The entries in the list are\ncomma-separated. The entry in the list single ASCII words.\n\n```css\n combi-modes: [window,drun];\n```\n\nFor older versions you have :\n\n```css\n combi-modes: \"window,drun\";\n```\n\n## Get a list of all possible options\n\nThere are 2 ways to get a list of all options:\n\n1. Dump the configuration file explained above. (`rofi -dump-config`)\n1. Look at output of `rofi -h`.\n\nTo see what values an option support check the manpage, it describes most of\nthem.\n\nNOTE: not all options might be in the manpage, as options can be added at\nrun-time. (f.e. by plugins).\n\n## Splitting configuration over multiple files\n\nIt is possible to split configuration over multiple files using imports. For\nexample in `~/.config/rofi/config.rasi`\n\n```css\nconfiguration {\n}\n@import \"myConfig\"\n@theme \"MyTheme\"\n\n```\n\nRofi will first parse the config block in `~/.config/rofi/config.rasi`, then\nparse `~/.config/rofi/myConfig.rasi` and then load the theme `myTheme`. More\ninformation can be obtained from the **rofi-theme(5)** manpage. Imports can be\nnested.\n" }, { "path": "COPYING", "content": "MIT/X11 License\nModified 2013-2024 Qball Cow \nCopyright (c) 2012 Sean Pringle \n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n" }, { "path": "Changelog", "content": "For newer release ChangeLogs please see the releasenotes.\n\nv1.7.3: Sturtled!\n - [Help] Print out the parsed config/theme files in -help output.\n - [Keybindings] Fix keybindings being modified by -theme-str\n - [Doc] Add rofi-dmenu manpage.\n - [XCB] Cache lookup of monitor.\n - Add -replace option (#568)\n - Fix memory leak.\n - [1566] Add extra debug for resolving monitors.\n - [Theme] Add round,floor,ceil function in @calc (#1569)\n - [Doc] Explain icon lookup.\n - [Combi] Add -combi-display-format (#1570) (thanks to Jakub)\n - [Theme] Expand list type ([]) for more data types.\n - [Theme] Add support for tab-stops on textbox. (#1571) (thanks to Jakub)\n - [Theme] Testing direct access to widgets via cmdline option (-theme+widget+property value)\n\nv1.7.2: Shellebrations!\n - [Build] Fix building without window mode enabled.\n - [Config] Do not print out the 'theme' field in configuration on dump.\n - [CI] test window mode less build.\n - Allow configuration block in theme again.\n\nv1.7.1: Turtley amazing!\n - [Theme] Fix highlight with only theme.\n - Updated documentation and landing page (Thanks to RaZ0rr-Two)\n - [Combi] Fix nesting combi modi (#1510)\n - [DMenu] Fix crash dmenu mode when no entry is available. (#1504)\n - [Run|Drun] Only initialize file-completer on first use.\n - [FileBrowser] Reduce number of re-allocs.\n - [Readme] Remove generating readme.html for dist.\n - [Dmenu] Fix uninitialized memory (non-selectable)\n - [FileBrowser] Try to convert invalid encoded text. (#1471)\n - [FileBrowser] Don't crash on invalid file filenames. (#1471)\n - [Theme] print known colors as its color name.\n - [CMD] If failed to convert commandline to new option, do not stop. (#1425)\n - [Theme] Fix parsing of nested media blocks. (#1442)\n - [Widgets] Fix sizing logic widgets. (#1437)\n - [Window] Try to fix auto-sizing of desktop names for non-i3 desktops. (#1439)\n - [Window] Fix broken close-on-delete. (#1421)\n - [Listview] Correctly check if selected item is highlighted. (#1423)\n - [Entry] Allow action to be taken on input change. (#1405)\n - [Theme] Don't truncate double values. (#1419)\n - [Grammar] Add support for env(ENV,default).\n - [Documentation] documentation fixes.\n - [Theme] fix dmenu theme ( #1396).\n\nv1.7.0: Iggy 2024\n - ADD: -steal-focus option.\n - ADD: [Config] Add nested configuration option support.\n - ADD: [Config] Support for handling dynamic config options.\n - ADD: [IconFetcher] Find images shipped with the theme.\n - ADD: [DRun] Add support for passing file (using file-browser) completer for desktop files that support his.\n - ADD: [DRun] Support for service files.\n - ADD: [FileBrowser] Allow setting startup directory (#1325)\n - ADD: [FileBrowser]: Add sorting-method. (#1340)\n - ADD: [FileBrowser] Add option to group directories ahead of files. (#1352)\n - ADD: [Filtering] Add prefix matching method. (#1237)\n - ADD: [Icon] Add option to square the widget.\n - ADD: [Icon|Button] Make action available on icon, button and keybinding name.\n - ADD: [KeyBinding] Add Ctrl-Shift-Enter option. (#874)\n - ADD: [ListView]-hover-select option. (#1234)\n - ADD: [Run] Add support for passing file (using file-browser) completer.\n - ADD: [Textbox] Allow theme to force markup on text widget.\n - ADD: [Theme] theme validation option. (`-rasi-validate`)\n - ADD: [View] Add support for user timeout and keybinding action.\n - ADD: [Widget] Add cursor property (#1313)\n - ADD: [Widget] Add scaling option to background-image.\n - ADD: [Widget] Add support background-image and lineair gradient option.\n - ADD: [Window] Add pango markup for window format (#1288)\n - ADD: [Window] Allow rofi to stay open after closing window.\n - FIX: [DSL] Move theme reset into grammar parser from lexer.\n - FIX: [Drun]: fix sorting on broken desktop files. (thanks to nick87720z)\n - FIX: [File Browser]: Fix escaping of paths.\n - FIX: [ListView] Fix wrong subwidget name.\n - FIX: [Script] Don't enable custom keybindings by default.\n - FIX: [TextBox] Fix height estimation.\n - FIX: [Theme] widget state and inherited properties. This should help fixing some old themes with changes from 1.6.1.\n - FIX: [Widget] Fix rendering of border and dashes. (Thanks to nick87720z)\n - FIX: [Build] Fix CI.\n - FIX: [Theme] Discard old theme, when explicitly passing one on command line.\n - REMOVE: -dump-xresources\n - REMOVE: -fullscreen\n - REMOVE: -show-match\n - REMOVE: Old xresources based configuration file.\n - REMOVE: fake transparency/background option, part of theme now.\n - REMOVE: xresources parsing via Xserver\n - Remove: [Theme] Remove backwards compatiblity hack.\n - DOC: Update changes to manpages\n\n\nv1.6.1: Tortoise Power\n - Use GdkPixbuf for Icon parsing.\n - Add FileBrowser to default mode.\n - Fix parsing dicts in config file (with \" in middle of string.)\n - Add -normalize-match option, that tries to o match ö, é match e. (#1119)\n - [Theme] Add min/max operator support to calc() (#1172)\n - Show error message and return to list instead of closing (#1187)\n - [Theme] Add nested media support. (#1189)\n - [Textbox] Try to fix estimated font height. (#1190)\n - [DRun] Fix broken caching mechanism.\n\nv1.6.0: The Masked Launcher\n - Add `themes/` directory in the users rofi config directory to the theme search path. (#1001)\n - Split listview element into box widget holding icon and textbox. Supporting more dynamic themes. (#949)\n - Fix default theme.\n - Add -upgrade-config option.\n - Add `ROFI_PLUGIN_PATH` variable.\n - Add check for running rofi inside a Script mode.\n - Remove gnome-terminal from rofi-sensible-terminal (#1074)\n - Set window title based on mode name. (#969)\n - Subpixel rendering workaround. (#303)\n - Support character type in configuration {} block . (#1131)\n - Use `XDG_CONFIG_DIRS` (#1133)\n - [Box] Bug fix update propagation.\n - [Build] Fix meson build with meson 0.55.\n - [DMenu] Add `-keep-right` flag. (#1089)\n - [DMenu] Don't match markup when filtering. (#579,#1128)\n - [DRUN] Support Type=Link (#1166)\n - [DRun] Add % to escape variable.\n - [DRun] Add an optional cache for desktop files. (#1040)\n - [DRun] Add keywords as default match item. (#1061)\n - [DRun] Don't run custom commands.\n - [DRun] Match keywords field.\n - [DRun] Only show selected categories. (#817)\n - [Dmenu|Script] Add non-selectable entries. (#1024)\n - [Doc] Update documentation.\n - [IconFetcher] Add jpeg support.\n - [Icon] Set default size to 1.2 CH.\n - [Icon] support distance for size.\n - [Listview] Add widget to show keybinding index. (#1050)\n - [Listview] Fix distribution of remaining space.\n - [Listview] Fix left-to-right scrolling. (#1028)\n - [Listview] Fix updating elements. (#1032)\n - [Matching] Make Fuzzy matching non greedy.\n - [Script] Add delimiter option. (#1041)\n - [Script] Add environment variable indicating state.\n - [Script] Add extra matchign field (meta). (#1052)\n - [Script] Add info option, hidden field that gets passed to script via `ROFI_INFO` environment.\n - [Script] Add no-custom option.\n - [Textbox] Add cursor blinking option.\n - [Textbox] Add placeholder. (#1020)\n - [Theme] Add `calc()` support. (#1105)\n - [Theme] Add alpha channel to highlight color. (#1033)\n - [Theme] Add sidebar as mode-switcher alias.\n - [Theme] Add some initial @media support. (#893)\n - [Theme] Support buttons in the UI.\n - [View] Add two widgets. One showing number of rows, other number of filtered rows. (#1026)\n - [Window] Add window thumbnail option.\n - [Window] Remove arbitrary # window limit. (#1047)\n - [Window] check buffer overflow.\n\nv1.5.5:\nv1.5.4: Painful tardiness\n\t- SSH: Fix wrong malloc size, causing crash.\n\nv1.5.3: Time delayed progress\n\t- Update manpage with missing entry. (#937)\n\t- Rename sidebar widget to mode-switcher and allow configuration from theme.\n\t- Timing: Moving timing output to glib debug system.\n\t- SSH: Fix unitialized variable issue.\n\t- SSH: resolve ':' conflict in history entries.\n\t- RASI Lexer: Fix nested () in variable default field.\n\t- USABILITY: When mode not found, show in gui not just on commandline.\n\t- ICON: Allow aligning image in icon widget.\n\t- Meson build system: cleanups and improvements.\n\t- Meson build system: add documentation (#943)\n\t- Window: Fix default formatting and remove (invalid) deprecation warning.\n\t- DMenu: Add support for showing icons infront of displayed list.\n\t- Overlay: Fix overlay widget to correctly integrate in new theme format.\n\t- Update libnkutils, libgwater.\n\t- SSH: be case-insensitive when parsing keywords.\n\t- DMENU: Add format option to strip pango markup from return value.\n\t- ListView: allow user to change ellipsizing displayed value at run-time.\n\nv1.5.2: Procrastination in progress\n\t- Clearify Check dependency. (#879)\n\t- Add option to change negate character. (#877)\n\t- Fix assert and update test. (#875)\n\t- Add missing example Script (#869)\n\t- Add drun-display-format option. (#858)\n\t- Fixing typos (#867,#837,#831,#804)\n\t- Fix loading icons that are in cache (#860)\n\t- Improve ssh known_host parser. (#820)\n\t- Add terminals to rofi-sensible-terminal (#808)\n\t- Lexer Fix several ambiguity and handling of empty input.\n\t- IconFetcher preload the user set icon theme.\n\t- IconFetcher use generic threadpool.\n\t- Lexer support environment variables.\n\t- Cleanup syntax for sorting. (#816)\n\t- Documents update.\n\t- Fix how borders are drawn. (#792, #783)\n\nv1.5.1:\n\t- Egor Zvorykin: Fix typos in theme manpage. (#760)\n\t- Ben: Fix README config file location. (#761)\n\t- [SSH] Reload when ssh entry is deleted.\n\t- Add support for randr 1.5 monitors. (#749)\n\t- Diki Anata: Fix border layout structure.\n\t- Remove duplicate tests. (#543)\n\t- Fix make test in libnkutils.\n\nv1.5.0:\n\t- [Theme] Accept integer notation for double properties. (#752)\n\t- [View] Theme textboxes are vertically sized and horizontal wrapped. (#754)\n\t- Rofi 1.4.2 doesn't capture ←, ↑, →, ↓ binding to keys to work in combination with Mode_switch (#744)\n\t- Add konsole to list of sensible terminals. (#739)\n\t- Allow drun to filter based on comment field. (#733)\n\t- Add prompt widget to default theme.\n\t- Add manpage for rofi-theme-selector.\n\t- Dump theme without # prefix and separator .\n\t- Fix issue with xnomad and -4 placing. (#683)\n\t- DRun obey OnlyShowIn and NotShowIn properties.\n\t- Store default theme in rofi binary using GResources.\n\t- Add extra margin between prompt and entry.\n\t- Remove colon from prompt. (#637)\n\t- Add support for passing extra properties in script mode.\n\t- Better error message on invalid argb syntax.\n\t- Fix default theme border.\n\t- Make '#' in the parser optional.\n\t- Update themes.\n\t- Add -drun/window-match-fields option (thx to Askrenteam) for drun/window menu. (#690/#656)\n\t- Implement negated match. (#665)\n\t- Fix parsing of non-existing fields. (#700)\n\t- rofi-theme-selector fixes.\n\t- Fix spelling error (thx to jmkjaer)\n\t- Fix test on i686/arm. (#692)\n\t- Fix error in theme manpage. (#686)\n\t- Allow history size to be specified. (#613)\n\t- Fix drun history implementation. (#579)\n\t- Add gentoo install instruction. (#685)\n\nv1.4.2:\n\t- Add sort to manpage. (#682)\n\t- Add tranaparent to theme manpage. (#688)\n\t- Re-add theme headers. (#679)\n\t- Fix super key. (#684)\n\t- Unknown option libnkutils:uuid. (#677)\n\t- Mode window is not found. (#686)\n\t- Fix meson build in dist file.\n\nv1.4.1: All Hail Rasi\n\t- Bump meson release version\n\nv1.4.0: I reject your truth and substitute my own\n\tNew Features:\n\t\t- FZF style sorting for fuzzy matching (thanks to MaskRay) (#533)\n\t\t- Improve error messages.\n\t\t - Theme parsing.\n\t\t - Keybinding.\n\t\t - invalid commandline options.\n\t\t - etc.\n\t\t- Customizable highlight.\n\t\t- Give up when keyboard is not grabbed in first 5 seconds.\n\t\t- Improved manpage\n\t\t\t- rofi (1)\n\t\t\t- rofi-themes (5)\n\t\t- Super-{1..10} hotkey for first 10 rows.\n\t\t- Allow x-align/y-align for textbox.\n\t\t- Support matching bangs on multiple characters in combi mode. (#542)\n\t\t- Set WM_CLASS (#549)\n\t\t- Async pre-read 25 rows for improving user experience. (#550)\n\t\t- Improve handling in floating window manager by always setting window size.\n\t\t- DRun speedup.\n\t\t- Make lazy-grab defualt.\n\t\t- Remove extra layer in textbox. (#553)\n\t\t- Ignore fonts that result in a family name or size 0. (#554)\n\t\t- [Combi] Allow bang to match multiple modes. (#552)\n\t\t- Add detection of window manager and work around quirks.\n\t\t- Support dynamic plugins.\n\t\t- DMENU tty detection.\n\t\t- Support for icons in drun, combi and window mode.\n\t\t- Startup notification of launched application support.\n\t\t- Meson support.\n\t\t- Fuzzy matching with fzf based sorting algorithm.\n\t\t- Auto-detect DPI.\n\t\t- Set cursor at the end of the input field. (#662)\n\t\t- Meson support (thx to SardemFF7).\n\t\t- [Script] parse the command as if it was commandline. (#650)\n\t\t- Don't enable asan by meson. (#642)\n\t\t- Allow text widgets to be added in theme and string to be set.\n\t\t- [Dmenu] Support the -w flag.\n\t\t- Allow window (via window id) to be location for rofi window.\n\t\t- [Dmenu] Allow multi-select mode in `-no-custom` mode.\n\nv1.3.1: Dan vs. Greg: The never ending story, reloaded.\n\tNew Features\n\t\t- [DRun] Search categories. (#449)\n\tImprovements\n\t\t- Fix exit when failed to grab keyboard. (#524)\n\t\t- Introduce lazy keyboard grab mode for people who want rofi to show on key-down in i3.\n\t\t- Add copyrights to theme (needed for debian packaging).\n\t\t- DMENU: Correctly detect end-of-file (#518)\n\t\t- Directly queue redraw on overlay change.\n\t\t- Remove pango markup from workspace names in I3. (#507)\n\nv1.3.0: Dan vs. Greg: The never ending story.\n\tNew Features\n\t\t- Use randr for getting monitor layout. Fallback to xinerama if not available.\n\t\t- Re-add fuzzy matcher.\n\t\t- Restructure internal code to use dynamic sizing widgets. (hbox, vbox and lists)\n\t\t- Async mode for dmenu.\n\t\t- Add theme selector script.\n\t\t- Include 21 themes.\n\t\t- Dynamically sizing window with content.\n\t\t- When placed at bottom of screen re-order screen to have entry at bottom.\n\tImprovements\n\t\t- Fix pasting secondary clipboard. (#516)\n\t\t- By default use all cores to filter entries.\n\t\t- Make sure drawing priority is higher then reading input data.\n\t\t- Improve resizing of window, don't make X whipe background.\n\t\t- Improve close window (shift-delete) action, by sending NET_WM_CLOSE instead of destroying window.\n\t\t- Create cache and run directory on startup. (#497)\n\t\t- Fix uneeded redraws on cursor blinking. (#491)\n\t\t- Improve time till grabbing keyboard. (#494)\n\t\t- Better error message when failing to parse keybindings, also continue parsing on error.\n\t\t- Fix problem with custom layouts (#485)\n\t\t- Speedup drawing of screen. Works well now for 4k and 8k screens. (factor 1000+ speedup for the flipping of\n\t\tbuffer) (#496)\n\t\t- DRun mode more compatible with specification.\n\t\t- Debug output via g_log.\n\t\t- Fix password entry cursor position.\n\t\t- Use bash instead of sh for get_git_rev.sh (#445)\n\t\t- Add Control+G for cancel (#452)\n\t\t- Add padding option to textbox (#449)\n\t\t- Ctrl-click does alternate accept entry. (#429)\n\t\t- Hide window decoration in normal window mode.\n\t\t- Click to exit option. (#460)\n\t\t- Fix cursor blinking on moving. (#462)\n\t\t- Remove entry from history if fails to execute (#466)\n\t\t- Fix margins. (#467)\n\t\t- Improved documentation of functions in code.\n\t\t- DRun: Set work directory when executing file. (#482)\n\t\t- Memory leak fixes.\n\t\t- Improve scrollbar behaviour.\n\tRemovals\n\t\t- opacity option. The transparency support in the theme can do the same and more.\n\nv1.2.0\n\tNew Features\n\t\t- Highlight matched part of the string.\n\t\t- Make window switcher string customizable.\n\tImprovements\n\t\t- Improved selection mode in dmenu with selection counter.\n\t\t- Improved selection mode with 'dot' indicator.\n\t\t- Fix Current Desktop window switcher.\n\t\t- Fix launching in terminal.\n\t\t- Supports include in config.\n\t\t- Add Control+k remove till eol keybinding.\n\t\t- Change clear line to Control+w and make Control+u remove till sol (matching readline)\n\t\t- Track origin of option value e.g. who set the option.\n\t\t- Comment default values in dump-xresources.\n\t\t- Fix displaying on 30bit 10bpc X setup.\n\tRemovals:\n\t\t- Remove xlib dependency (xcb-xrm)\n\t\t- Remove fuzzy option\n\t\t- Remove i3 workaround as it no longer needed since I3 v4.9. (Feb. 2015)\n\nv1.1.0\n New Features\n - Keys mode, showing keybindings.\n - Stop cycling option (#407) (Thx to Yaroslav)\n - Kill window on delete entry (#316)\n Improvements\n - Add Control+Backspace as remove word back keybinding.\n - Allow user to use X11 background for fake transparency (#390)\n - Allow user to specify background image.\n - Improved keybinding handling, allowing on-release and modifier only (#384).\n - Use display name for prompt (#409)\n - Parse subdirectories in drun parser (#416)\n - Switch to stop cycling (#407)\n Bug fixes\n - Grab mouse pointer with keyboard\n\n1.0.1\n Bug fixes\n - Fix typo in manpage.\n - Return old behaviour for rofi placement (#395, #389)\n - Switch desktop when switching window (#393)\n - Remove unneeded use of bash (#391)\n - Make history parser more robust against corrupted files. (#388)\n - Fix desktop number (#386)\n\n1.0.0\n New Features\n\n - Blinking cursor\n - BliSeparate configuration file\n - BliHistory in drun mode (#343)\n - BliContext menu mode, show rofi at the mouse pointer\n\n Improvement\n - auto select and single item on dmenu mode (#281)\n - Unlimited window title length.\n - Correctly follow the active desktop, instead of active window.\n - If requesting modi that is not enabled, show it anyway.\n - DMenu password mode. (#315)\n - Levenshtein sort is now UTF-8 aware.\n - Use xcb instead of large xlib library.\n - Use GLib mainloop for cleaner code and easier external event based\n - handling in future.\n - Run dialog: Try to convert between locale, fs encoding and utf8.\n - Fixing problems with non-utf8 filesystem encodings.\n - Try to display non-utf8 strings as good as possible.\n - Autocomplete bang hint in combi mode (#380)\n - Remove magic line length limits by switching to getline\n - from fgets.\n - Print git version for git builds in version string.\n\n Bug fixes\n - Fix subpixel rendering. (#303)\n - Fix basic tests on OpenBSD (#272)\n - Fix wrong use of memcpy (thx to Jasperia).\n - Work around for sigwaitinfo on OpenBSD.\n - Ignore invalid entries (non-utf8) in dmenu mode.\n - Glib signal handling.\n - Fix connecting to i3 on bsd.\n - Be able to distinguish between empty and cancel in dmenu mode. (#323)\n - Fix memcpy on single memory region. (#312)\n - Fix opening file with mode a+ and using fseek to overwrite on bsd.\n\n0.15.12:\n New features:\n - Initial `-dump` command for dmenu mode. (#216)\n - Threading support.\n - Parallel checking for ASCII.\n - Parallel string matching.\n - Autodetect number of HW-threads.\n - Disabled by default.\n - Highlight multiple selected rows (#287,#293)\n - Dmenu can read from file instead of stdin.\n - Regex matching (#113)\n - Take Screenshot of rofi using keybinding.\n - Hotkey for sorting: (#298)\n\t\t- Option to set scrollbar width.\n Improvements:\n\t\t- Fix return code of multi-select.\n - Update manpage (#289, #291)\n - Improve speed of reading stdin in dmenu mode.\n - Correctly handle modifier keys now. Should now support most weird keyboard layouts and switching between them.\n (#268, #265, #286)\n - Correctly set locale, fixing issues with entering special characters. (#282)\n - DRun mode support `NoDisplay` setting (#283)\n - Pango markup is matched when filtering. (#273)\n Bug fixes:\n - Improve error message (#290)\n - Correctly switch to next entry on multi-select when list is filtered (#292)\n - Switch __FUNCTION__ for __func__. (#288)\n - Fix segfault on empty list and moving through it. (#256,#275)\n - Fix one off of colors (#269)\n - Drun fix uninitialized memory (#285)\n\n0.15.11:\n New features:\n - (Experimental) Desktop file support\n Improvement:\n - Add xdg-terminal to rofi-sensible-terminal\n Bug fixes:\n - manpage fixes (#261)\n - Crash in error mesg on invalid config\n - Fix urgent and active being activated at same time\n - Fix crasher on empty list\n0.15.10:\n New feature:\n - Support for Startup Notification\n - Standalone mode in dmenu\n - ssh: known_hosts parsing\n - Full screen support\n - Glob style matching\n - Cairo drawing\n - Fast ascii filtering (thx to Tom Hinton)\n - Combi bang support\n - normal window mode for dmenu\n - Startup notification support\n - Current desktop window mode\n Improvements:\n - Keep same line selected\n - Cleanup menu code by re-using Switcher\n - Fix drawing on resize\n - Fix rofi -h output\n - allow disabling of tokenizing\n - Dragging scrollbar\n - Allow none type on separator\n - Dmenu support markup in fields\n Bug fixes:\n - dmenu use switcher system\n - release keyboard on focus out event, regrab it on focus in event\n - Support `\\0` separator\n\n0.15.8:\n New feature:\n - Scrollbar.\n - More custom keybindings.\n Improvements:\n - dmenu compatibility.\n - Don't refilter on all keypresses.\n - Hide Docks and desktops from the window list. (remove i3bar hack)\n Bug fixes:\n - Fix Desktop numbering.\n - Mis-alignment of arrow down box with message (#189)\n - Fix issue with mouse interaction needing keyboard press to complete.\n - Fix -no-custom still allows escape to quit.\n - Fix compiler warnings.\n - Fix dmenu mode. (#200)\n - Break CMD AI to have dmenu compatibility.\n - Fix processing of signals.\n\n0.15.7:\n Bug fixes:\n - Auto-wrap text in message dialog.\n - Fix ellipsiziing in entry box.\n - Fix crash on empty list with custom input (#175).\n - SSH: Ignore comments in Host line (#178).\n - Fix issues with BSD (#180)\n New feature:\n - Markup support error message.\n - Implement -no-custom as alternative to -only-select (#176).\n - Fuzzy match option. (#133)\n Improvements:\n - Make more keys user-configurable. (#66)\n\n0.15.5:\n Bug fixes:\n - Reduce time waiting for keyboard grab (#153)\n - Also grab Key Release on exit. (#167)\n - Fix failing font size estimation code.\n New feature:\n - [DMENU] Allow to select line matching pattern from cmdline.(#165)\n - [DMENU] Allow to set filter from cmdline. (#164)\n - [DMENU] Allow output to be formatted (string, filter, index, index 1 based)\n - [DMENU] Only match input lines mode.\n - [DMENU] Custom keybinding for return value.(#154,#156)\n - [DMENU] Allow additional message line. (#166)\n Improvements:\n - (Start) adding keybinding support (#131)\n - Cleanup warnings from clang checkers.\n - Fix keybindings on Russian layout (#169)\n Open bugs:\n - Urgency hint not always working (#162)\n\n0.15.4:\n New feature:\n - Number mode for dmenu. allows user to get index back instead of content.\n - Combi mode. Combine multiple views into one.\n - Highlight current window.\n - Highlight urgent and active row in window view.\n - DMenu allow rows to be highlighted. (single, multiple, ranges)\n - New color specification based on I3. (Can be enabled by settings) (#147)\n - /etc/hosts support for ssh mode. (#137)\n Bug fixes:\n - On a single item in list disable auto-select.\n - Fix cursor position (#140)\n - Resolving manpage. (#142)\n - Fix pasting cursor one off. (#150)\n - Fix grave key -> ctrl+grave (#151)\n Improvements:\n - Better handle input methods.. Now international keyboard layout works as expected: `e ->è\n - Be more verbose about starting in daemon mode.\n - Print a user-understandable error when launching in daemon mode without a key bound.\n - Add Ctrl(Shift)Tab to switch modi's.\n - Auto size number of columns based on available columns.\n - Better way to determine font height.\n - Fix font vertical centering.\n - One-off when pasting text.\n - Improve rendering of boxes (fixed height and margins)\n - Fix modi switcher boxes size+layout.\n - Reduce work on redraws (do not always calculate new size/position), set text, etc.\n - OO-ify the switchers.\n - Remove unneeded filtered array.\n Cleanup:\n - Do not lug argc,argv around everywhere.\n\n0.15.2:\n Removed features:\n - Remove (broken) hmode\n - Old style key binding and mode launcher.\n - Old TIMING code.\n New features:\n - Word movement in entry box. (#126)\n - PID file to avoid duplicate Rofi.\n - Generic keybinding and launching for modi. (#128)\n - Auto select mode (previously called zeltak mode)\n Bug fixes:\n - Shift left/right movement between modi (#125)\n - Document updates (#123,#116,#124,etc.)\n - DMenu mode based on executable name with full path (#119)\n - Fix missing keystrokes.\n - On broken UTF-8 show everything up to the broken character. (#121)\n Others:\n - Significant code refactoring.\n - Rewriting of config parser, Commandline Parser uses structure from Xresource parser.\n Avoiding duplication and making it easier to maintain.\n Performance improvements:\n - Fix blocking on grabbing keyboard.\n\n0.15.1:\n New features:\n - Improved transparency\n - Changelog\n - Case sensitivity support, with indicator. (Edwin Pujols)\n - Mouse scroll wheel support\n - Alternate Row colors\n - Run-list command for adding entries to run-dialog\n - Dmenu: preselect line.\n Bug fixes:\n - Manpage fixes\n - SSH viewer, support lists of hostnames (Tblue)\n - SSH improve parsing of odly indented host files\n - Do not loose keypresses when system under load\n - Cleanups, small fixes. (Edwin Pujols, blueyed )\n Performance improvements:\n - Lazy refilter for large lists\n" }, { "path": "Examples/i3_empty_workspace.sh", "content": "#!/usr/bin/env bash\n\nMAX_DESKTOPS=20\n\nWORKSPACES=$(seq -s '\\n' 1 1 \"${MAX_DESKTOPS}\")\n\nEMPTY_WORKSPACE=$( (i3-msg -t get_workspaces | tr ',' '\\n' | grep num | awk -F: '{print int($2)}' ; \\\n echo -e \"${WORKSPACES}\" ) | sort -n | uniq -u | head -n 1)\n\ni3-msg workspace \"${EMPTY_WORKSPACE}\"\n" }, { "path": "Examples/i3_switch_workspaces.sh", "content": "#!/usr/bin/env bash\n\nif [ -z $@ ]\nthen\ngen_workspaces()\n{\n i3-msg -t get_workspaces | tr ',' '\\n' | grep \"name\" | sed 's/\"name\":\"\\(.*\\)\"/\\1/g' | sort -n\n}\n\necho empty; gen_workspaces\nelse\n WORKSPACE=$@\n\n if [ \"${WORKSPACE}\" = \"empty\" ]\n then\n i3_empty_workspace.sh >/dev/null\n elif [ -n \"${WORKSPACE}\" ]\n then\n i3-msg workspace \"${WORKSPACE}\" >/dev/null\n fi\nfi\n" }, { "path": "Examples/rofi-file-browser.sh", "content": "#!/usr/bin/env bash\n\n# Various options for the file browser script:\nROFI_FB_GENERIC_FO=\"xdg-open\" # command used for opening the selection\nROFI_FB_PREV_LOC_FILE=~/.local/share/rofi/rofi_fb_prevloc\nROFI_FB_HISTORY_FILE=~/.local/share/rofi/rofi_fb_history\nROFI_FB_HISTORY_MAXCOUNT=5 # maximum number of history entries\n# Comment the next variable to always start in the last visited directory,\n# otherwise rofi_fb will start in the specified directory:\nROFI_FB_START_DIR=$HOME # starting directory\n# Uncomment the following line to disable history:\n# ROFI_FB_NO_HISTORY=1\n\n# Beginning of the script:\n# Create the directory for the files of the script\nif [ ! -d \"$(dirname \"${ROFI_FB_PREV_LOC_FILE}\")\" ]\nthen\n mkdir -p \"$(dirname \"${ROFI_FB_PREV_LOC_FILE}\")\"\nfi\nif [ ! -d \"$(dirname \"${ROFI_FB_HISTORY_FILE}\")\" ]\nthen\n mkdir -p \"$(dirname \"${ROFI_FB_HISTORY_FILE}\")\"\nfi\n\n# Initialize $ROFI_FB_CUR_DIR\nif [ -d \"${ROFI_FB_START_DIR}\" ]\nthen\n ROFI_FB_CUR_DIR=\"${ROFI_FB_START_DIR}\"\nelse\n ROFI_FB_CUR_DIR=\"$PWD\"\nfi\n\n# Read last location, otherwise we default to $ROFI_FB_START_DIR or $PWD.\nif [ -f \"${ROFI_FB_PREV_LOC_FILE}\" ]\nthen\n ROFI_FB_CUR_DIR=$(cat \"${ROFI_FB_PREV_LOC_FILE}\")\nfi\n\n# Handle argument.\nif [ -n \"$@\" ]\nthen\n if [[ \"$@\" == /* ]]\n then\n ROFI_FB_CUR_DIR=\"$@\"\n else\n ROFI_FB_CUR_DIR=\"${ROFI_FB_CUR_DIR}/$@\"\n fi\nfi\n\n# If argument is no directory.\nif [ ! -d \"${ROFI_FB_CUR_DIR}\" ]\nthen\n if [ -x \"${ROFI_FB_CUR_DIR}\" ]\n then\n coproc ( \"${ROFI_FB_CUR_DIR}\" >/dev/null 2>&1 )\n exec 1>&-\n exit;\n elif [ -f \"${ROFI_FB_CUR_DIR}\" ]\n then\n if [[ \"${ROFI_FB_NO_HISTORY}\" -ne 1 ]]\n then\n # Append selected entry to history and remove exceeding entries\n sed -i \"s|${ROFI_FB_CUR_DIR}|##deleted##|g\" \"${ROFI_FB_HISTORY_FILE}\"\n sed -i '/##deleted##/d' \"${ROFI_FB_HISTORY_FILE}\"\n echo \"${ROFI_FB_CUR_DIR}\" >> \"${ROFI_FB_HISTORY_FILE}\"\n if [ \"$( wc -l < \"${ROFI_FB_HISTORY_FILE}\" )\" -gt \"${ROFI_FB_HISTORY_MAXCOUNT}\" ]\n then\n sed -i 1d \"${ROFI_FB_HISTORY_FILE}\"\n fi\n fi\n # Open the selected entry with $ROFI_FB_GENERIC_FO\n coproc ( \"${ROFI_FB_GENERIC_FO}\" \"${ROFI_FB_CUR_DIR}\" >/dev/null 2>&1 )\n if [ -d \"${ROFI_FB_START_DIR}\" ]\n then\n echo \"${ROFI_FB_START_DIR}\" > \"${ROFI_FB_PREV_LOC_FILE}\"\n fi\n exit;\n fi\n exit;\nfi\n\n# Process current dir.\nif [ -n \"${ROFI_FB_CUR_DIR}\" ]\nthen\n ROFI_FB_CUR_DIR=$(readlink -e \"${ROFI_FB_CUR_DIR}\")\n echo \"${ROFI_FB_CUR_DIR}\" > \"${ROFI_FB_PREV_LOC_FILE}\"\n pushd \"${ROFI_FB_CUR_DIR}\" >/dev/null\nfi\n\n# Output to rofi\nif [[ \"${ROFI_FB_NO_HISTORY}\" -ne 1 ]]\nthen\n tac \"${ROFI_FB_HISTORY_FILE}\" | grep \"${ROFI_FB_CUR_DIR}\"\nfi\necho \"..\"\nls\n# vim:sw=4:ts=4:et:\n" }, { "path": "Examples/test_script_env.sh", "content": "#!/usr/bin/env bash\n\nif [ -z \"${ROFI_OUTSIDE}\" ]\nthen\n echo \"run this script in rofi\".\n exit\nfi\n\necho -en \"\\x00no-custom\\x1ffalse\\n\"\necho -en \"\\x00data\\x1fmonkey do, monkey did\\n\"\necho -en \"\\x00use-hot-keys\\x1ftrue\\n\"\necho -en \"${ROFI_RETV}\\x00icon\\x1ffirefox\\x1finfo\\x1ftest\\n\"\n\nif [ -n \"${ROFI_INFO}\" ]\nthen\n echo \"my info: ${ROFI_INFO} \"\nfi\nif [ -n \"${ROFI_DATA}\" ]\nthen\n echo \"my data: ${ROFI_DATA} \"\nfi\n" }, { "path": "Examples/test_script_mode.sh", "content": "#!/usr/bin/env bash\n\nif [ \"$*\" = \"quit\" ]; then\n\texit 0\nfi\n\nif [ \"$@\" ]; then\n\t# Override the previously set prompt.\n\techo -en \"\\x00prompt\\x1fChange prompt\\n\"\n\tfor a in {1..10}; do\n\t\techo \"$a\"\n\tdone\n\techo \"quit\"\nelse\n\techo -en \"\\x00prompt\\x1ftesting\\n\"\n\techo -en \"\\0urgent\\x1f0,2\\n\"\n\techo -en \"\\0active\\x1f1\\n\"\n\techo -en \"\\0markup-rows\\x1ftrue\\n\"\n\techo -en \"\\0message\\x1fSpecial boldmessage\\n\"\n\n\techo -en \"aap\\0icon\\x1ffolder\\n\"\n\techo -en \"blob\\0icon\\x1ffolder\\x1fdisplay\\x1fblub\\n\"\n\techo \"noot\"\n\techo \"mies\"\n\techo -en \"-------------\\0nonselectable\\x1ftrue\\x1fpermanent\\x1ftrue\\n\"\n\techo \"testing\"\n\techo \"Bold\"\n\techo \"quit\"\nfi\n" }, { "path": "Examples/test_script_mode_color.sh", "content": "#!/usr/bin/env bash\n\nif [ \"$*\" = \"quit\" ]\nthen\n exit 0\nfi\n\nif [ \"$@\" ]\nthen\n # Override the previously set prompt.\n echo -en \"\\0theme\\x1felement-text { background-color: $@;}\\n\"\n echo -en \"\\0keep-selection\\x1ftrue\\n\"\n# echo -en \"\\0new-selection\\x1f2\\n\"\n echo \"red\"\n echo \"lightgreen\"\n echo \"lightblue\"\n echo \"lightyellow\"\n echo \"quit\"\nelse\n echo -en \"\\x00prompt\\x1ftesting\\n\"\n echo -en \"\\0urgent\\x1f0,2\\n\"\n echo -en \"\\0active\\x1f1\\n\"\n echo -en \"\\0keep-selection\\x1ftrue\\n\"\n echo -en \"\\0message\\x1fSpecial boldmessage\\n\"\n\n echo \"red\"\n echo \"lightgreen\"\n echo \"lightblue\"\n echo \"lightyellow\"\n echo \"pink\"\n echo \"green\"\n echo \"blue\"\n echo \"gold\"\n echo \"quit\"\nfi\n" }, { "path": "Examples/test_script_mode_delim.sh", "content": "#!/usr/bin/env bash\n\nif [[ \"$@\" = \"quit\" ]]\nthen\n exit 0\nfi\n\n# Override the previously set prompt.\n# We only want to do this on first call of script.\nif [[ $ROFI_RETV = 0 ]]\nthen\n echo -en \"\\x00delim\\x1f\\\\x1\\n\"\nfi\necho -en \"\\x00message\\x1fmy line1\\nmyline2\\nmy line3\\x1\"\necho -en \"\\x00prompt\\x1fChange prompt\\x1\"\nfor a in {1..10}\ndo\n echo -en \"$a\\x1\"\ndone\necho -en \"newline\\ntest\\x1\"\necho -en \"quit\"\n" }, { "path": "INSTALL.md", "content": "# Installation guide\n\nThis guide explains how to install rofi using its build system and how you can\nmake debug builds.\n\nRofi uses [Meson](https://mesonbuild.com/) as build system.\nBe default rofi builds with both backends (x11 and wayland) if available on the\nsystem. If no backend is found, it will give an error.\nYou can force the build system to disable the [wayland](#disable-wayland-support)\nor [x11](#disable-x11-support) backend.\n\n## DEPENDENCY\n\n### For building\n\n- C compiler that supports the c99 standard. (gcc or clang)\n\n- meson\n\n- ninja\n\n- pkg-config\n\n- flex 2.5.39 or higher\n\n- bison\n\n- check (Can be disabled using the `--disable-check` configure flag)\n check is used for build-time tests and does not affect functionality.\n\n- Developer packages of the external libraries\n\n- glib-compile-resources\n\n### External libraries\n\n- libpango >= 1.50\n\n- libpangocairo\n\n- libcairo\n\n- libcairo-xcb\n\n- libglib2.0 >= 2.72\n - gmodule-2.0\n - gio-unix-2.0\n\n- libgdk-pixbuf-2.0\n\n- libstartup-notification-1.0\n\n- libxkbcommon >= 0.4.1\n\n- libxkbcommon-x11\n\n- libxcb (sometimes split, you need libxcb, libxcb-xkb and libxcb-randr\n libxcb-xinerama)\n\n- xcb-util\n\n- xcb-util-wm (sometimes split as libxcb-ewmh and libxcb-icccm)\n\n- xcb-util-cursor\n\n- xcb-imdkit (optional, 1.0.3 or up preferred)\n\nOn debian based systems, the developer packages are in the form of:\n`-dev` on rpm based `-devel`.\n\nFor wayland support:\n\n- wayland\n- wayland-protocols >= 1.17\n\n## Install from a release\n\nWhen downloading from the github release page, make sure to grab the archive\n`rofi-{version}.tar.[g|x]z`. The auto-attached files `source code (zip|tar.gz)`\nby github do not contain a valid release. It misses a setup build system and\nincludes irrelevant files.\n\n### Meson\n\nCheck dependencies and configure build system:\n\n```bash\n meson setup build\n```\n\nBuild Rofi:\n\n```bash\n ninja -C build\n```\n\nThe actual install, execute as root (if needed):\n\n```bash\n ninja -C build install\n```\n\nThe default installation prefix is: `/usr/local/` use `meson setup build\n--prefix={prefix}` to install into another location.\n\n## Install a checkout from git\n\nThe GitHub Pages version of these directions may be out of date. Please use\n[INSTALL.md from the online repo][master-install] or your local repository.\n\nIf you don't have a checkout:\n\n```bash\n git clone --recursive https://github.com/DaveDavenport/rofi\n cd rofi/\n```\n\nIf you already have a checkout:\n\n```bash\n cd rofi/\n git pull\n git submodule update --init\n```\n\nFrom this point, use the same steps you use for a release.\n\n## Options for building\n\nWhen you run the configure step there are several options you can configure.\n\nFor Meson, before the initial setup, you can see rofi options in\n`meson_options.txt` and Meson options with `meson setup --help`. Meson's\nbuilt-in options can be set using regular command line arguments, like so:\n`meson setup build --option=value`. Rofi-specific options can be set using the\n`-D` argument, like so: `meson setup build -Doption=value`. After the build dir\nis set up by `meson setup build`, the `meson configure build` command can be\nused to configure options, by the same means.\n\nThe most useful one to set is the installation prefix:\n\n```bash\n # Meson\n meson setup build --prefix \n```\n\nf.e.\n\n```bash\n # Meson\n meson setup build --prefix /usr\n```\n\n### Disable x11 support\n\n```bash\nmeson setup build -Dxcb=disabled\n```\n\n### Disable wayland support\n\n```bash\nmeson setup build -Dwayland=disabled\n```\n\n### Install locally\n\nor to install locally:\n\n```bash\n # Meson\n meson setup build --prefix ${HOME}/.local\n```\n\n### Verbose build output\n\nShow the commands called (when using ninja):\n\n```bash\n # Meson\n ninja -C build -v\n```\n\n### Debug build\n\nCompile with debug symbols and no optimization, this is useful for making\nbacktraces:\n\n```bash\n # Meson\n meson configure build --debug\n ninja -C build\n```\n\n### Get a backtrace\n\nGetting a backtrace using GDB is not very handy. Because if rofi get stuck, it\ngrabs keyboard and mouse. So if it crashes in GDB you are stuck. The best way\nto go is to enable core file. (ulimit -c unlimited in bash) then make rofi\ncrash. You can then load the core in GDB.\n\n```bash\n # Meson (because it uses a separate build directory)\n gdb build/rofi core\n```\n\n> Where the core file is located and what its exact name is different on each\n> distributions. Please consult the relevant documentation.\n\nFor more information see the rofi-debugging(5) manpage.\n\n## Install distribution\n\n### Debian or Ubuntu\n\n```bash\n apt install rofi\n```\n\n### Fedora\n\n```bash\n dnf install rofi\n```\n\n### ArchLinux\n\n```bash\n pacman -S rofi\n```\n\n### Gentoo\n\nAn ebuild is available, `x11-misc/rofi`. It's up to date, but you may need to\nenable ~arch to get the latest release:\n\n```bash\n echo 'x11-misc/rofi ~amd64' >> /etc/portage/package.accept_keywords\n```\n\nfor amd64 or:\n\n```bash\n echo 'x11-misc/rofi ~x86' >> /etc/portage/package.accept_keywords\n```\n\nfor i386.\n\nTo install it, simply issue `emerge rofi`.\n\n### openSUSE\n\nOn both openSUSE Leap and openSUSE Tumbleweed rofi can be installed using:\n\n```bash\n sudo zypper install rofi\n```\n\n### FreeBSD\n\n```bash\n sudo pkg install rofi\n```\n\n### macOS\n\nOn macOS rofi can be installed via [MacPorts](https://www.macports.org):\n\n```bash\n sudo port install rofi\n```\n\n[master-install]: https://github.com/DaveDavenport/rofi/blob/master/INSTALL.md#install-a-checkout-from-git\n" }, { "path": "README.md", "content": "

\n\n\n\n\n\n

\n\n**Please match the documentation and scripts to the version of rofi used**\n\n- [next version](https://github.com/davatorium/rofi)\n- [2.0.0](https://github.com/davatorium/rofi/tree/2.0.0)\n- [1.7.9](https://github.com/davatorium/rofi/tree/1.7.9)\n- [1.7.8](https://github.com/davatorium/rofi/tree/1.7.8)\n- [1.7.7](https://github.com/davatorium/rofi/tree/1.7.7)\n- [1.7.6](https://github.com/davatorium/rofi/tree/1.7.6)\n- [1.7.5](https://github.com/davatorium/rofi/tree/1.7.5)\n- [1.7.4](https://github.com/davatorium/rofi/tree/1.7.4)\n- [1.7.3](https://github.com/davatorium/rofi/tree/1.7.3)\n- [1.7.2](https://github.com/davatorium/rofi/tree/1.7.2)\n- [1.7.1](https://github.com/davatorium/rofi/tree/1.7.1)\n- [1.7.0](https://github.com/davatorium/rofi/tree/1.7.0)\n\nAlso see the locally installed documentation (manpages).\n\n

Rofi

\n

A window switcher, Application launcher and dmenu replacement.

\n\n\n\n**Rofi** started as a clone of simpleswitcher, written by [Sean\nPringle](http://github.com/seanpringle/simpleswitcher) - a popup window\nswitcher roughly based on\n[superswitcher](http://code.google.com/p/superswitcher/). Simpleswitcher laid\nthe foundations, and therefore Sean Pringle deserves most of the credit for\nthis tool. **Rofi** (renamed, as it lost the *simple* property) has been\nextended with extra features, like an application launcher and ssh-launcher,\nand can act as a drop-in dmenu replacement, making it a very versatile tool.\nThanks to the great work of [lbonn](https://github.com/lbonn), who added\nWayland support in his fork and maintained it for years, **Rofi**\nnow officially supports Wayland (since 2025).\n\n**Rofi**, like dmenu, will provide the user with a textual list of options\nwhere one or more can be selected.\nThis can either be running an application, selecting a window, or options\nprovided by an external script.\n\n### What is rofi not?\n\nRofi is not:\n\n- A UI toolkit.\n\n- A library to be used in other applications.\n\n- An application that can support every possible use-case. It tries to be\n generic enough to be usable by everybody.\n - Specific functionality can be added using scripts or plugins, many exists.\n\n- Just a dmenu replacement. The dmenu functionality is a nice 'extra' to\n **rofi**, not its main purpose.\n\n## Table of Contents\n\n- [Features](#features)\n- [Modes](#modes)\n- [Manpages](#manpage)\n- [Installation](#installation)\n- [Quickstart](#quickstart)\n - [Usage](#usage)\n - [Configuration](#configuration)\n - [Themes](#themes)\n- [Screenshots](#screenshots)\n- [Wiki](#wiki)\n- [Discussion places](#discussion-places)\n\n## Features\n\nIts main features are:\n\n- Fully configurable keyboard navigation\n\n- Type to filter\n - Tokenized: type any word in any order to filter\n - Case insensitive (togglable) or SmartCase\n - Support for fuzzy-, regex-, prefix-, and glob-matching\n\n- UTF-8 enabled\n - UTF-8-aware string collating\n - International keyboard support (\\`e -> è)\n\n- RTL language support\n\n- Cairo drawing and Pango font rendering\n\n- Built-in modes:\n - Window switcher mode\n - EWMH compatible WM\n - Work arounds for i3,bspwm\n - Wayland based WMs that follow the wlr family\n\n - Application launcher\n\n - Desktop file application launcher\n\n - SSH launcher mode\n\n - File browser\n\n - Combi mode, allowing several modes to be merged into one list\n\n- History-based ordering — last 25 choices are ordered on top based on use\n (optional)\n\n- Levenshtein distance or fzf like sorting of matches (optional)\n\n- Drop-in dmenu replacement\n - Many added improvements\n\n- Easily extensible using scripts and plugins\n\n- Advanced Theming\n\n## Modes\n\n**Rofi** has several built-in modes implementing common use cases and can be\nextended by scripts (either called from\n**Rofi** or calling **Rofi**) or plugins.\n\nBelow is a list of the different modes:\n\n- **run**: launch applications from $PATH, with option to launch in terminal.\n\n- **drun**: launch applications based on desktop files. It tries to be\n compliant to the XDG standard.\n\n- **window**: Switch between windows on an EWMH compatible window manager.\n\n- **ssh**: Connect to a remote host via ssh.\n\n- **filebrowser**: A basic file-browser for opening files.\n\n- **keys**: list internal keybindings.\n\n- **script**: Write (limited) custom mode using simple scripts.\n\n- **combi**: Combine multiple modes into one.\n\n**Rofi** is known to work on Linux and BSD.\n\n## Wayland support\n\n### Build\n\nPlease follow the [build instructions](INSTALL.md) to build rofi.\n\nWayland support is enabled by default, along with X11/xcb.\n\nrofi can also be built *without* X11/xcb or wayland, but atleast one backend\nshould be enabled:\n\n meson build -Dxcb=disabled\n meson build -Dwayland=disabled\n\n### Usage\n\n**Rofi** should automatically select the xcb or wayland backend depending on\nthe environment it is run on.\n\nTo force the use of the xcb backend (if enabled during build), the `-x11`\noption can be used:\n\n rofi -x11 ...\n\n### Missing features in Wayland mode\n\nDue to the different architecture and available APIs in Wayland mode, some original rofi features are difficult or impossible to replicate\n\n- `-normal-window` flag. Though it is also considered as a toy/deprecated feature in Upstream rofi. Not impossible but would require some work.\n- `-monitor -n` for fine-grained selection of monitor to display rofi on\n- some window locations parameters work partially, `x-offset` and `y-offset` are only working from screen edges\n- fake transparency\n- window mode on KWin which implements different protocols than the wlr family\n\n### Wayland DPI\n\nOn wayland, the output is only known after the first surface is shown. This makes sizing\nrofi windows in absolute size (mm) very difficult, a problem unique for rofi,\nas the actual DPI is unknown before hand. This can be worked around by manually\npassing the right DPI via configuration system. If the `dpi` config option is\nset to `0` and only one monitor is connected rofi will use the DPI of the only\nconnected monitor or if you have multiple monitors and you specify a monitor\nname, it will use the DPI of that monitor.\n\n## Manpage\n\nFor more up to date information, please see the manpages. The other sections\nand links might have outdated information as they have relatively less\nmaintainance than the manpages. So, if you come across any issues please\nconsult manpages, [discussion](https://github.com/davatorium/rofi/discussions)\nand [issue tracker](https://github.com/davatorium/rofi/issues?q=) before filing\nnew issue.\n\n- Manpages:\n - [rofi](doc/rofi.1.markdown)\n - [rofi-theme](doc/rofi-theme.5.markdown)\n - [rofi-debugging](doc/rofi-debugging.5.markdown)\n - [rofi-script](doc/rofi-script.5.markdown)\n - [rofi-theme-selector](doc/rofi-theme-selector.1.markdown)\n - [rofi-thumbnails](doc/rofi-thumbnails.5.markdown)\n - [rofi-keys](doc/rofi-keys.5.markdown)\n - [rofi-dmenu](doc/rofi-dmenu.5.markdown)\n\n## Installation\n\nPlease see the [installation guide](INSTALL.md) for instructions on how to\ninstall **Rofi**.\n\n## Quickstart\n\n### Usage\n\n> **This section just gives a brief overview of the various options. To get the\n> full set of options see the [manpages](#manpage) section above**\n\n#### Running rofi\n\nTo launch **rofi** directly in a certain mode, specify a mode with `rofi -show `.\nTo show the `run` dialog:\n\n```bash\n rofi -show run\n```\n\nOr get the options from a script:\n\n```bash\n ~/my_script.sh | rofi -dmenu\n```\n\nSpecify an ordered, comma-separated list of modes to enable. Enabled modes can\nbe changed at runtime. Default key is `Ctrl+Tab`. If no modes are specified,\nall configured modes will be enabled. To only show the `run` and `ssh`\nlauncher:\n\n```bash\n rofi -modes \"run,ssh\" -show run\n```\n\nThe modes to combine in combi mode.\nFor syntax to `-combi-modes`, see `-modes`.\nTo get one merge view, of `window`,`run`, and `ssh`:\n\n```bash\n rofi -show combi -combi-modes \"window,run,ssh\" -modes combi\n```\n\n### Configuration\n\nGenerate a default configuration file\n\n```bash\nmkdir -p ~/.config/rofi\nrofi -dump-config > ~/.config/rofi/config.rasi\n```\n\nThis creates a file called `config.rasi` in the `~/.config/rofi/` folder. You\ncan modify this file to set configuration settings and modify themes.\n`config.rasi` is the file rofi looks to by default.\n\nPlease see the [configuration\nguide](https://github.com/davatorium/rofi/blob/next/CONFIG.md) for a summary of\nconfiguration options. More detailed options are provided in the manpages.\n\n### Themes\n\nPlease see the [themes\nmanpages](https://github.com/davatorium/rofi/blob/next/doc/rofi-theme.5.markdown)\nfor a detailed description.\n\nThe latest bundled themes can be found\n[here](https://github.com/davatorium/rofi/tree/next/themes).\n\n## Screenshots\n\nRezlooks:\n\n![screenshot](https://raw.githubusercontent.com/davatorium/rofi/next/releasenotes/1.6.0/icons.png)\n\nArthur:\n\n![screenshot2](https://raw.githubusercontent.com/davatorium/rofi/next/releasenotes/1.6.0/icons2.png)\n\nDefault theme:\n\n![default](https://raw.githubusercontent.com/davatorium/rofi/next/releasenotes/1.4.0/rofi-no-fzf.png)\n\n## Wiki\n\n| ❗ **The Wiki is currently unmaintained and might contain outdated data** |\n| --- |\n\n[Go to wiki](https://github.com/davatorium/rofi/wiki) .\n\n### Contents\n\n- [User scripts](https://github.com/davatorium/rofi/wiki/User-scripts)\n- [Examples](https://github.com/davatorium/rofi/wiki#examples)\n- [dmenu Specs](https://github.com/davatorium/rofi/wiki/dmenu_specs)\n- [mode Specs](https://github.com/davatorium/rofi/wiki/mode-Specs)\n- [F.A.Q.](https://github.com/davatorium/rofi/wiki/Frequently-Asked-Questions).\n- [Script mode](https://github.com/davatorium/rofi/wiki/rfc-script-mode)\n- [Creating an issue](https://github.com/davatorium/rofi/blob/master/.github/CONTRIBUTING.md)\n- [Creating a Pull request](https://github.com/davatorium/rofi/wiki/Creating-a-pull-request)\n\n## Discussion places\n\nThe [GitHub Discussions](https://github.com/davatorium/rofi/discussions) is the\npreferred location for discussions.\n\n- [GitHub Discussions](https://github.com/davatorium/rofi/discussions)\n- IRC (#rofi on irc.libera.chat)\n\n### Stargazers over time\n\n[![Stargazers over time](https://starchart.cc/davatorium/rofi.svg)](https://starchart.cc/davatorium/rofi)\n" }, { "path": "config/config.c", "content": "/*\n * rofi\n *\n * MIT/X11 License\n * Copyright © 2013-2023 Qball Cow \n *\n * Permission is hereby granted, free of charge, to any person obtaining\n * a copy of this software and associated documentation files (the\n * \"Software\"), to deal in the Software without restriction, including\n * without limitation the rights to use, copy, modify, merge, publish,\n * distribute, sublicense, and/or sell copies of the Software, and to\n * permit persons to whom the Software is furnished to do so, subject to\n * the following conditions:\n *\n * The above copyright notice and this permission notice shall be\n * included in all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\n * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\n * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\n * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\n * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\n * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n *\n */\n\n#include \"config.h\"\n#include \"rofi-types.h\"\n#include \"settings.h\"\n#include \n#include \n#include \n\nSettings config = {\n/** List of enabled modes. */\n/** -modes */\n#ifdef WINDOW_MODE\n .modes = \"window,drun,run,ssh\",\n#else\n .modes = \"drun,run,ssh\",\n#endif\n /** Font */\n .menu_font = \"mono 12\",\n\n /** Whether to load and show icons */\n .show_icons = FALSE,\n\n /** Custom command to generate preview icons */\n .preview_cmd = NULL,\n\n /** Custom command to call when menu selection changes */\n .on_selection_changed = NULL,\n /** Custom command to call when menu mode changes */\n .on_mode_changed = NULL,\n /** Custom command to call when menu entry is accepted */\n .on_entry_accepted = NULL,\n /** Custom command to call when menu is canceled */\n .on_menu_canceled = NULL,\n /** Custom command to call when menu finds errors */\n .on_menu_error = NULL,\n /** Custom command to call when menu screenshot is taken */\n .on_screenshot_taken = NULL,\n /** Terminal to use. (for ssh and open in terminal) */\n .terminal_emulator = \"rofi-sensible-terminal\",\n .ssh_client = \"ssh\",\n /** Command when executing ssh. */\n .ssh_command = \"{terminal} -e {ssh-client} {host} [-p {port}]\",\n /** Command when running */\n .run_command = \"{cmd}\",\n /** Command used to list executable commands. empty -> internal */\n .run_list_command = \"\",\n /** Command executed when running application in terminal */\n .run_shell_command = \"{terminal} -e {cmd}\",\n /** Command executed on accep-entry-custom for window modus */\n .window_command = \"wmctrl -i -R {window}\",\n /** No default icon theme, we search Adwaita and gnome as fallback */\n .icon_theme = NULL,\n /**\n * Location of the window.\n * Enumeration indicating location or gravity of window.\n *\n * WL_NORTH_WEST WL_NORTH WL_NORTH_EAST\n *\n * WL_EAST WL_CENTER WL_EAST\n *\n * WL_SOUTH_WEST WL_SOUTH WL_SOUTH_EAST\n *\n */\n .location = WL_CENTER,\n /**\n * On Wayland, specifies the layer where rofi is rendered. Available layers are\n * `background`, `bottom`, `top`, `overlay`. The default layer is `overlay`.\n */\n .wayland_layer = \"overlay\",\n /** Y offset */\n .y_offset = 0,\n /** X offset */\n .x_offset = 0,\n /** Always show config.menu_lines lines, even if less lines are available */\n .fixed_num_lines = TRUE,\n /** Do not use history */\n .disable_history = FALSE,\n /** Programs ignored for history */\n .ignored_prefixes = \"\",\n /** Sort the displayed list */\n .sort = FALSE,\n /** Use levenshtein sorting when matching */\n .sorting_method = \"normal\",\n /** Case sensitivity of the search */\n .case_sensitive = FALSE,\n /** Case smart of the search */\n .case_smart = FALSE,\n /** Cycle through in the element list */\n .cycle = TRUE,\n /** Height of an element in #chars */\n .element_height = 1,\n /** Sidebar mode, show the modes */\n .sidebar_mode = FALSE,\n /** auto select */\n .auto_select = FALSE,\n /** Parse /etc/hosts file in ssh view. */\n .parse_hosts = FALSE,\n /** Parse ~/.ssh/known_hosts file in ssh view. */\n .parse_known_hosts = TRUE,\n /** Modes to combine into one view. */\n .combi_modes = \"window,run\",\n .tokenize = TRUE,\n .matching = \"normal\",\n .matching_method = MM_NORMAL,\n\n /** Desktop entries to match in drun */\n .drun_match_fields = \"name,generic,exec,categories,keywords\",\n /** Only show entries in this category */\n .drun_categories = NULL,\n /** Exclude entries in this category */\n .drun_exclude_categories = NULL,\n /** Desktop entry show actions */\n .drun_show_actions = FALSE,\n /** Desktop format display */\n .drun_display_format =\n \"{name} [({generic})]\",\n /** Desktop Link launch command */\n .drun_url_launcher = \"xdg-open\",\n\n /** Window fields to match in window mode*/\n .window_match_fields = \"all\",\n /** Monitor */\n .monitor = \"-5\",\n /** Set filter */\n .filter = NULL,\n .dpi = -1,\n .threads = 0,\n .scroll_method = 0,\n .window_format = \"{w} {c} {t}\",\n .click_to_exit = TRUE,\n .global_kb = FALSE,\n .theme = NULL,\n .plugin_path = PLUGIN_PATH,\n .max_history_size = 25,\n .combi_hide_mode_prefix = FALSE,\n .combi_display_format = \"{mode} {text}\",\n\n .matching_negate_char = '-',\n\n .cache_dir = NULL,\n .window_thumbnail = FALSE,\n\n /** drun cache */\n .drun_use_desktop_cache = FALSE,\n .drun_reload_desktop_cache = FALSE,\n\n /** Benchmarks */\n .benchmark_ui = FALSE,\n\n /** normalize match */\n .normalize_match = FALSE,\n /** steal focus */\n .steal_focus = FALSE,\n /** fallback icon */\n .application_fallback_icon = NULL,\n /** refilter limit in ms*/\n .refilter_timeout_limit = 300,\n /** workaround for broken xserver (#300 on xserver, #611) */\n .xserver_i300_workaround = FALSE,\n /** What browser to use for completion */\n .completer_mode = \"filebrowser\",\n /** Whether to enable imdkit, see #2123 */\n .enable_imdkit = TRUE,\n};\n" }, { "path": "data/rofi-theme-selector.desktop", "content": "[Desktop Entry]\nEncoding=UTF-8\nVersion=1.0\nType=Application\nTerminal=false\nExec=rofi-theme-selector\nName=Rofi Theme Selector\nIcon=rofi\n" }, { "path": "data/rofi.desktop", "content": "[Desktop Entry]\nEncoding=UTF-8\nVersion=1.0\nType=Application\nTerminal=false\nExec=rofi -show\nName=Rofi\nIcon=rofi\n" }, { "path": "doc/README.md", "content": "Manpages are build using [pandoc](https://pandoc.org/)\n\nManpages can be updated using the following make command:\n\n```\nmake generate-manpage\n```\n" }, { "path": "doc/default_configuration.rasi", "content": "configuration {\n\n // Timeout from user input.\n timeout {\n // The delay after inactivity to execute action.\n delay: 0;\n // The action to execute once the delay expires.\n action: \"kb-cancel\";\n }\n\n // File browser mode.\n filebrowser {\n sorting-method: \"name\";\n directories-first: true;\n }\n}\n\n@theme \"default\"\n" }, { "path": "doc/default_theme.rasi", "content": "/**\n * rofi -dump-theme output.\n **/\n* {\n red: rgba ( 220, 50, 47, 100 % );\n selected-active-foreground: var(background);\n lightfg: rgba ( 88, 104, 117, 100 % );\n separatorcolor: var(foreground);\n urgent-foreground: var(red);\n alternate-urgent-background: var(lightbg);\n lightbg: rgba ( 238, 232, 213, 100 % );\n spacing: 2;\n border-color: var(foreground);\n normal-background: var(background);\n background-color: rgba ( 0, 0, 0, 0 % );\n alternate-active-background: var(lightbg);\n active-foreground: var(blue);\n blue: rgba ( 38, 139, 210, 100 % );\n urgent-background: var(background);\n alternate-normal-foreground: var(foreground);\n selected-active-background: var(blue);\n background: rgba ( 253, 246, 227, 100 % );\n selected-normal-foreground: var(lightbg);\n active-background: var(background);\n alternate-active-foreground: var(blue);\n alternate-normal-background: var(lightbg);\n foreground: rgba ( 0, 43, 54, 100 % );\n selected-urgent-background: var(red);\n selected-urgent-foreground: var(background);\n normal-foreground: var(foreground);\n alternate-urgent-foreground: var(red);\n selected-normal-background: var(lightfg);\n}\nelement {\n padding: 1px ;\n spacing: 5px ;\n border: 0;\n cursor: pointer;\n}\nelement normal.normal {\n background-color: var(normal-background);\n text-color: var(normal-foreground);\n}\nelement normal.urgent {\n background-color: var(urgent-background);\n text-color: var(urgent-foreground);\n}\nelement normal.active {\n background-color: var(active-background);\n text-color: var(active-foreground);\n}\nelement selected.normal {\n background-color: var(selected-normal-background);\n text-color: var(selected-normal-foreground);\n}\nelement selected.urgent {\n background-color: var(selected-urgent-background);\n text-color: var(selected-urgent-foreground);\n}\nelement selected.active {\n background-color: var(selected-active-background);\n text-color: var(selected-active-foreground);\n}\nelement alternate.normal {\n background-color: var(alternate-normal-background);\n text-color: var(alternate-normal-foreground);\n}\nelement alternate.urgent {\n background-color: var(alternate-urgent-background);\n text-color: var(alternate-urgent-foreground);\n}\nelement alternate.active {\n background-color: var(alternate-active-background);\n text-color: var(alternate-active-foreground);\n}\nelement-text {\n background-color: rgba ( 0, 0, 0, 0 % );\n text-color: inherit;\n highlight: inherit;\n cursor: inherit;\n}\nelement-icon {\n background-color: rgba ( 0, 0, 0, 0 % );\n size: 1.0000em ;\n text-color: inherit;\n cursor: inherit;\n}\nwindow {\n padding: 5;\n background-color: var(background);\n border: 1;\n}\nmainbox {\n padding: 0;\n border: 0;\n}\nmessage {\n padding: 1px ;\n border-color: var(separatorcolor);\n border: 2px dash 0px 0px ;\n}\ntextbox {\n text-color: var(foreground);\n}\nlistview {\n padding: 2px 0px 0px ;\n scrollbar: true;\n border-color: var(separatorcolor);\n spacing: 2px ;\n fixed-height: 0;\n border: 2px dash 0px 0px ;\n}\nscrollbar {\n width: 4px ;\n padding: 0;\n handle-width: 8px ;\n border: 0;\n handle-color: var(normal-foreground);\n}\nsidebar {\n border-color: var(separatorcolor);\n border: 2px dash 0px 0px ;\n}\nbutton {\n spacing: 0;\n text-color: var(normal-foreground);\n cursor: pointer;\n}\nbutton selected {\n background-color: var(selected-normal-background);\n text-color: var(selected-normal-foreground);\n}\n\nnum-filtered-rows, num-rows {\n text-color: grey;\n expand: false;\n}\ntextbox-num-sep {\n text-color: grey;\n expand: false;\n str: \"/\";\n}\ninputbar {\n padding: 1px;\n spacing: 0px;\n text-color: var(normal-foreground);\n children: [ prompt,textbox-prompt-colon,entry, overlay,num-filtered-rows, textbox-num-sep, num-rows, case-indicator ];\n}\noverlay {\n background-color: var(normal-foreground);\n foreground-color: var(normal-background);\n text-color: var(normal-background);\n padding: 0 0.2em;\n margin: 0 0.2em;\n}\ncase-indicator {\n spacing: 0;\n text-color: var(normal-foreground);\n}\nentry {\n spacing: 0;\n text-color: var(normal-foreground);\n placeholder-color: grey;\n placeholder: \"Type to filter\";\n cursor: text;\n}\nprompt {\n spacing: 0;\n text-color: var(normal-foreground);\n}\ntextbox-prompt-colon {\n margin: 0px 0.3000em 0.0000em 0.0000em ;\n expand: false;\n str: \":\";\n text-color: inherit;\n}\n" }, { "path": "doc/man_filter.lua", "content": "local Def = {}\n\nfunction Def:new(d)\n -- init with empty def\n if d == nil then\n d = {\n start_idx = nil,\n end_idx = nil,\n def_par = nil,\n content = {},\n }\n end\n setmetatable(d, self)\n self.__index = self\n return d\nend\n\nfunction Def:init(start_idx, el)\n self.start_idx = start_idx\n self.def_par = el\nend\n\nfunction Def:append(el)\n if self.start_idx ~= nil then\n table.insert(self.content, el)\n end\nend\n\nfunction Def:stop(end_idx)\n if self.start_idx == nil then\n return nil\n end\n local out = self:new({\n start_idx = self.start_idx,\n end_idx = end_idx,\n def_par = self.def_par,\n content = self.content,\n })\n self.start_idx = nil\n self.end_idx = nil\n self.def_par = nil\n self.content = {}\n return out\nend\n\nfunction Def:to_string()\n return string.format(\"start: %d, end: %d, def_par: %s\", self.start_idx, self.end_idx, self.def_par)\nend\n\nfunction find_defs(doc)\n local defs = {}\n local idx = 0\n local def = Def:new()\n\n -- find defintions:\n -- * start at paragraphs with `word` ...\n -- * stop at next definition or next header\n local filter = {\n traverse = \"topdown\",\n Para = function(el)\n idx = idx + 1\n\n local new_def_start = #el.content >= 1 and el.content[1].tag == \"Code\"\n\n if new_def_start then\n local newd = def:stop(idx - 1)\n table.insert(defs, newd)\n\n def:init(idx, el.content)\n else\n def:append(el)\n end\n return nil, false\n end,\n Block = function(el)\n idx = idx + 1\n def:append(el)\n -- stop exploring after one nesting level\n return nil, false\n end,\n Header = function(el)\n idx = idx + 1\n local newd = def:stop(idx - 1)\n table.insert(defs, newd)\n return nil, false\n end,\n }\n\n doc:walk(filter)\n local newd = def:stop(idx - 1)\n table.insert(defs, newd)\n\n return defs\nend\n\nfunction convert_defs(doc, defs)\n local idx = 0\n local out_blocks = {}\n\n local convert_defs = {\n traverse = \"topdown\",\n Block = function(el)\n idx = idx + 1\n for _, d in ipairs(defs) do\n if idx == d.end_idx then\n local dl = pandoc.DefinitionList({ { d.def_par, { d.content } } })\n table.insert(out_blocks, dl:walk())\n return {}, false\n end\n if idx >= d.start_idx and idx < d.end_idx then\n -- drop\n return {}, false\n end\n end\n table.insert(out_blocks, el:walk())\n return nil, false\n end,\n }\n\n doc:walk(convert_defs)\n\n return pandoc.Pandoc(out_blocks, doc.meta)\nend\n\n-- for <2.17 compatibility\n-- equivalent to `doc:walk(filter)`\nlocal function walk_doc(doc, filter)\n local div = pandoc.Div(doc.blocks)\n local blocks = pandoc.walk_block(div, filter).content\n return pandoc.Pandoc(blocks, doc.meta)\nend\n\nlocal function extract_title(doc)\n local title = {}\n local section\n local filter = {\n Header = function(el)\n local f = {\n Str = function(el)\n if el.text:find(\"%(1%)\") ~= nil then\n section = \"General Commands Manual\"\n elseif el.text:find(\"%(5%)\") ~= nil then\n section = \"File Formats Manual\"\n end\n table.insert(title, el)\n end,\n Inline = function(el)\n table.insert(title, el)\n end,\n }\n if el.level == 1 then\n pandoc.walk_block(el, f)\n return {} -- drop\n end\n return nil\n end,\n }\n\n doc = walk_doc(doc, filter)\n\n local to_inline = function(s)\n local r = {}\n for w in s:gmatch(\"%S+\") do\n table.insert(r, pandoc.Str(w))\n table.insert(r, pandoc.Space())\n end\n table.remove(r, #r)\n return r\n end\n\n if section ~= nil then\n for _, e in ipairs({\n pandoc.Space(),\n pandoc.Str(\"rofi\"),\n pandoc.Space(),\n pandoc.Str(\"|\"),\n table.unpack(to_inline(section)),\n }) do\n table.insert(title, e)\n end\n end\n\n doc.meta = pandoc.Meta({\n title = pandoc.MetaInlines(title),\n })\n\n return doc\nend\n\nlocal function decrement_heading(doc)\n local filter = {\n Header = function(el)\n if el.level > 1 then\n el.level = el.level - 1\n return el\n end\n return nil\n end,\n }\n\n doc = walk_doc(doc, filter)\n return doc\nend\n\nlocal function code_in_strong(doc)\n local filter = {\n Code = function(el)\n return pandoc.Strong(el.text)\n end,\n }\n\n doc = walk_doc(doc, filter)\n return doc\nend\n\n--- Run filtering function through whole document\n--\n-- * find argument definitions: paragraph starting with inline code (`-arg`)\n-- * replace the paragraphs until the end of the definition with a DefinitionList\n-- * extract metadata title from main heading\n-- * decrement heading from 1 for better display\n-- * convert inline code text to Strong as usual in man pages\nfunction Pandoc(doc)\n if PANDOC_VERSION >= pandoc.types.Version(\"2.17.0\") then\n -- 2.17 is required for topdown traversal\n local defs = find_defs(doc)\n doc = convert_defs(doc, defs)\n end\n\n doc = extract_title(doc)\n\n doc = decrement_heading(doc)\n\n doc = code_in_strong(doc)\n\n return doc\nend\n" }, { "path": "doc/meson.build", "content": "man_files = [\n 'rofi.1',\n 'rofi-sensible-terminal.1',\n 'rofi-theme-selector.1',\n 'rofi-actions.5',\n 'rofi-debugging.5',\n 'rofi-dmenu.5',\n 'rofi-keys.5',\n 'rofi-script.5',\n 'rofi-theme.5',\n 'rofi-thumbnails.5',\n]\n\nfs = import('fs')\n\npandoc = find_program('pandoc', required: false, version: '>=2.9')\n\nif pandoc.found()\n man_targets = []\n cp_cmds = []\n foreach f: man_files\n section_number = f.split('.')[1]\n install_dest = join_paths(get_option('prefix'), get_option('mandir'), 'man' + section_number)\n\n man_targets += custom_target(f,\n input: ['.'.join([f, 'markdown']), 'man_filter.lua'],\n output: f,\n command: [ 'pandoc', '--standalone', '--to=man',\n '--lua-filter', '@INPUT1@',\n '-f', 'markdown-tex_math_dollars',\n '@INPUT0@', '-o', '@OUTPUT@' ],\n install: true,\n install_dir: install_dest,\n build_by_default: true,\n )\n endforeach\n\n run_target('generate-manpage', command: ['true'], depends: man_targets)\nelse\n man_missing = false\n foreach f: man_files\n if not fs.is_file(f)\n man_missing = true\n endif\n endforeach\n\n if man_missing\n warning('Man files cannot be generated and not present in source directory, they will not be installed')\n else\n install_man(man_files)\n endif\nendif\n\ndoxy_conf = configuration_data()\ndoxy_conf.set('PACKAGE', meson.project_name())\ndoxy_conf.set('VERSION', meson.project_version())\ndoxy_conf.set('abs_builddir', join_paths(meson.project_build_root(), meson.current_build_dir()))\ndoxy_conf.set('abs_top_srcdir', meson.project_source_root())\n\ndoxyfile = configure_file(\n input: 'rofi.doxy.in',\n output: 'rofi.doxy',\n configuration: doxy_conf,\n)\n\ndoxygen = find_program('doxygen', required: false)\nif doxygen.found()\n html_target = custom_target('doxy',\n input: doxyfile,\n output: 'html',\n command: [doxygen, doxyfile],\n install: false,\n )\nendif\n" }, { "path": "doc/rofi-actions.5.markdown", "content": "# rofi-actions(5)\n\n## NAME\n\n**rofi-actions** - Custom commands following interaction with rofi menus\n\n## DESCRIPTION\n\n**rofi** allows to set custom commands or scripts to be executed when some actions are performed in the menu, such as changing selection, accepting an entry or canceling.\n\nThis makes it possible for example to play sound effects or read aloud menu entries on selection.\n\n## USAGE\n\nFollowing is the list of rofi flags for specifying custom commands or scripts to execute on supported actions:\n\n`-on-selection-changed` *cmd*\n\nCommand or script to run when the current selection changes. Selected text is forwarded to the command replacing the pattern *{entry}*.\n\n`-on-entry-accepted` *cmd*\n\nCommand or script to run when a menu entry is accepted. Accepted text is forwarded to the command replacing the pattern *{entry}*.\n\n`-on-mode-changed` *cmd*\n\nCommand or script to run when the menu mode (e.g. drun,window,ssh...) is changed.\n\n`-on-menu-canceled` *cmd*\n\nCommand or script to run when the menu is canceled.\n\n`-on-menu-error` *cmd*\n\nCommand or script to run when an error menu is shown (e.g. `rofi -e \"error message\"`). Error text is forwarded to the command replacing the pattern *{error}*.\n\n`-on-screenshot-taken` *cmd*\n\nCommand or script to run when a screenshot of rofi is taken. Screenshot path is forwarded to the command replacing the pattern *{path}*.\n\n### Example usage\n\nRofi command line:\n\n```bash\nrofi -on-selection-changed \"/path/to/select.sh {entry}\" \\\n -on-entry-accepted \"/path/to/accept.sh {entry}\" \\\n -on-menu-canceled \"/path/to/exit.sh\" \\\n -on-mode-changed \"/path/to/change.sh\" \\\n -on-menu-error \"/path/to/error.sh {error}\" \\\n -on-screenshot-taken \"/path/to/camera.sh {path}\" \\\n -show drun\n```\n\nRofi config file:\n\n```css\nconfiguration {\n on-selection-changed: \"/path/to/select.sh {entry}\";\n on-entry-accepted: \"/path/to/accept.sh {entry}\";\n on-menu-canceled: \"/path/to/exit.sh\";\n on-mode-changed: \"/path/to/change.sh\";\n on-menu-error: \"/path/to/error.sh {error}\";\n on-screenshot-taken: \"/path/to/camera.sh {path}\";\n}\n```\n\n### Play sound effects\n\nHere's an example bash script that plays a sound effect using `aplay` when the current selection is changed:\n\n```bash\n#!/bin/bash\n\ncoproc aplay -q $HOME/Music/selecting_an_item.wav\n```\n\nThe use of `coproc` for playing sounds is suggested, otherwise the rofi process will wait for sounds to end playback before exiting.\n\n### Read aloud\n\nHere's an example bash script that reads aloud currently selected entries using `espeak`:\n\n```bash\n#!/bin/bash\n\nkillall espeak\necho \"selected: $@\" | espeak\n```\n" }, { "path": "doc/rofi-debugging.5.markdown", "content": "# rofi-debugging(5)\n\n## NAME\n\nDebugging rofi.\n\nWhen reporting an issue with rofi crashing, or misbehaving. It helps to do some\nsmall test to help pin-point the problem.\n\nFirst try disabling your custom configuration: `-no-config`\n\nThis disables the parsing of the configuration files. This runs rofi in *stock*\nmode.\n\nIf you run custom C plugins, you can disable the plugins using: `-no-plugins`\n\n## Get the relevant information for an issue\n\nPlease pastebin the output of the following commands:\n\n```bash\nrofi -help\nrofi -dump-config\nrofi -dump-theme\n```\n\n`rofi -help` provides us with the configuration files parsed, the exact\nversion, monitor layout and more useful information.\n\nThe `rofi -dump-config` and `rofi -dump-theme` output gives us `rofi`\ninterpretation of your configuration and theme.\n\nPlease check the output for identifiable information and remove this.\n\n## Timing traces\n\nTo get a timing trace, enable the **Timings** debug domain.\n\n```bash\nG_MESSAGES_DEBUG=Timings rofi -show drun\n```\nIt will show a trace with (useful) timing information at relevant points during\nthe execution. This will help debugging when rofi is slow to start.\n\nExample trace:\n\n```text\n(process:14942): Timings-DEBUG: 13:47:39.335: 0.000000 (0.000000): Started\n(process:14942): Timings-DEBUG: 13:47:39.335: 0.000126 (0.000126): ../source/rofi.c:main:786 \n(process:14942): Timings-DEBUG: 13:47:39.335: 0.000163 (0.000037): ../source/rofi.c:main:819 \n(process:14942): Timings-DEBUG: 13:47:39.336: 0.000219 (0.000056): ../source/rofi.c:main:826 Setup Locale\n(process:14942): Timings-DEBUG: 13:47:39.337: 0.001235 (0.001016): ../source/rofi.c:main:828 Collect MODI\n(process:14942): Timings-DEBUG: 13:47:39.337: 0.001264 (0.000029): ../source/rofi.c:main:830 Setup MODI\n(process:14942): Timings-DEBUG: 13:47:39.337: 0.001283 (0.000019): ../source/rofi.c:main:834 Setup mainloop\n(process:14942): Timings-DEBUG: 13:47:39.337: 0.001369 (0.000086): ../source/rofi.c:main:837 NK Bindings\n(process:14942): Timings-DEBUG: 13:47:39.337: 0.001512 (0.000143): ../source/xcb.c:display_setup:1177 Open Display\n(process:14942): Timings-DEBUG: 13:47:39.337: 0.001829 (0.000317): ../source/xcb.c:display_setup:1192 Setup XCB\n(process:14942): Timings-DEBUG: 13:47:39.346: 0.010650 (0.008821): ../source/rofi.c:main:844 Setup Display\n(process:14942): Timings-DEBUG: 13:47:39.346: 0.010715 (0.000065): ../source/rofi.c:main:848 Setup abe\n(process:14942): Timings-DEBUG: 13:47:39.350: 0.015101 (0.004386): ../source/rofi.c:main:883 Load cmd config \n(process:14942): Timings-DEBUG: 13:47:39.351: 0.015275 (0.000174): ../source/rofi.c:main:907 Setup Modi\n(process:14942): Timings-DEBUG: 13:47:39.351: 0.015291 (0.000016): ../source/view.c:rofi_view_workers_initialize:1922 Setup Threadpool, start\n(process:14942): Timings-DEBUG: 13:47:39.351: 0.015349 (0.000058): ../source/view.c:rofi_view_workers_initialize:1945 Setup Threadpool, done\n(process:14942): Timings-DEBUG: 13:47:39.367: 0.032018 (0.016669): ../source/rofi.c:main:1000 Setup late Display\n(process:14942): Timings-DEBUG: 13:47:39.367: 0.032080 (0.000062): ../source/rofi.c:main:1003 Theme setup\n(process:14942): Timings-DEBUG: 13:47:39.367: 0.032109 (0.000029): ../source/rofi.c:startup:668 Startup\n(process:14942): Timings-DEBUG: 13:47:39.367: 0.032121 (0.000012): ../source/rofi.c:startup:677 Grab keyboard\n(process:14942): Timings-DEBUG: 13:47:39.368: 0.032214 (0.000093): ../source/view.c:__create_window:701 xcb create window\n(process:14942): Timings-DEBUG: 13:47:39.368: 0.032235 (0.000021): ../source/view.c:__create_window:705 xcb create gc\n(process:14942): Timings-DEBUG: 13:47:39.368: 0.033136 (0.000901): ../source/view.c:__create_window:714 create cairo surface\n(process:14942): Timings-DEBUG: 13:47:39.369: 0.033286 (0.000150): ../source/view.c:__create_window:723 pango cairo font setup\n(process:14942): Timings-DEBUG: 13:47:39.369: 0.033351 (0.000065): ../source/view.c:__create_window:761 configure font\n(process:14942): Timings-DEBUG: 13:47:39.381: 0.045896 (0.012545): ../source/view.c:__create_window:769 textbox setup\n(process:14942): Timings-DEBUG: 13:47:39.381: 0.045944 (0.000048): ../source/view.c:__create_window:781 setup window attributes\n(process:14942): Timings-DEBUG: 13:47:39.381: 0.045955 (0.000011): ../source/view.c:__create_window:791 setup window fullscreen\n(process:14942): Timings-DEBUG: 13:47:39.381: 0.045966 (0.000011): ../source/view.c:__create_window:797 setup window name and class\n(process:14942): Timings-DEBUG: 13:47:39.381: 0.045974 (0.000008): ../source/view.c:__create_window:808 setup startup notification\n(process:14942): Timings-DEBUG: 13:47:39.381: 0.045981 (0.000007): ../source/view.c:__create_window:810 done\n(process:14942): Timings-DEBUG: 13:47:39.381: 0.045992 (0.000011): ../source/rofi.c:startup:679 Create Window\n(process:14942): Timings-DEBUG: 13:47:39.381: 0.045999 (0.000007): ../source/rofi.c:startup:681 Parse ABE\n(process:14942): Timings-DEBUG: 13:47:39.381: 0.046113 (0.000114): ../source/rofi.c:startup:684 Config sanity check\n(process:14942): Timings-DEBUG: 13:47:39.384: 0.048229 (0.002116): ../source/dialogs/run.c:get_apps:216 start\n(process:14942): Timings-DEBUG: 13:47:39.390: 0.054626 (0.006397): ../source/dialogs/run.c:get_apps:336 stop\n(process:14942): Timings-DEBUG: 13:47:39.390: 0.054781 (0.000155): ../source/dialogs/drun.c:get_apps:634 Get Desktop apps (start)\n(process:14942): Timings-DEBUG: 13:47:39.391: 0.055264 (0.000483): ../source/dialogs/drun.c:get_apps:641 Get Desktop apps (user dir)\n(process:14942): Timings-DEBUG: 13:47:39.418: 0.082884 (0.027620): ../source/dialogs/drun.c:get_apps:659 Get Desktop apps (system dirs)\n(process:14942): Timings-DEBUG: 13:47:39.418: 0.082944 (0.000060): ../source/dialogs/drun.c:get_apps_history:597 Start drun history\n(process:14942): Timings-DEBUG: 13:47:39.418: 0.082977 (0.000033): ../source/dialogs/drun.c:get_apps_history:617 Stop drun history\n(process:14942): Timings-DEBUG: 13:47:39.419: 0.083638 (0.000661): ../source/dialogs/drun.c:get_apps:664 Sorting done.\n(process:14942): Timings-DEBUG: 13:47:39.419: 0.083685 (0.000047): ../source/view.c:rofi_view_create:1759 \n(process:14942): Timings-DEBUG: 13:47:39.419: 0.083700 (0.000015): ../source/view.c:rofi_view_create:1783 Startup notification\n(process:14942): Timings-DEBUG: 13:47:39.419: 0.083711 (0.000011): ../source/view.c:rofi_view_create:1786 Get active monitor\n(process:14942): Timings-DEBUG: 13:47:39.420: 0.084693 (0.000982): ../source/view.c:rofi_view_refilter:1028 Filter start\n(process:14942): Timings-DEBUG: 13:47:39.421: 0.085992 (0.001299): ../source/view.c:rofi_view_refilter:1132 Filter done\n(process:14942): Timings-DEBUG: 13:47:39.421: 0.086090 (0.000098): ../source/view.c:rofi_view_update:982 \n(process:14942): Timings-DEBUG: 13:47:39.421: 0.086123 (0.000033): ../source/view.c:rofi_view_update:1002 Background\n(process:14942): Timings-DEBUG: 13:47:39.428: 0.092864 (0.006741): ../source/view.c:rofi_view_update:1008 widgets\n```\n\n## Debug domains\n\nTo further debug the plugin, you can get a trace with (lots of) debug\ninformation. This debug output can be enabled for multiple parts in rofi using\nthe glib debug framework. Debug domains can be enabled by setting the\nG\\_MESSAGES\\_DEBUG environment variable. At the time of creation of this page,\nthe following debug domains exist:\n\n- all: Show debug information from all domains.\n- X11Helper: The X11 Helper functions.\n- View: The main window view functions.\n- Widgets.Box: The Box widget.\n- Modes.DMenu: The dmenu mode.\n- Modes.Run: The run mode.\n- Modes.DRun: The desktop file run mode.\n- Modes.Window: The window mode.\n- Modes.Script: The script mode.\n- Modes.Combi: The script mode.\n- Modes.Ssh: The ssh mode.\n- Rofi: The main application.\n- Timings: Get timing output.\n- Theme: Theme engine debug output. (warning lots of output).\n- Widgets.Icon: The Icon widget.\n- Widgets.Box: The box widget.\n- Widgets.Container: The container widget.\n- Widgets.Window: The window widget.\n- Helpers.IconFetcher: Information about icon lookup.\n\nFor full list see `man rofi`.\n\nExample: `G_MESSAGES_DEBUG=Dialogs.DRun rofi -show drun` To get specific output\nfrom the Desktop file run dialog.\n\nTo redirect the debug output to a file (`~/rofi.log`) add:\n\n```bash\nrofi -show drun -log ~/rofi.log\n```\n\nSpecifying the logfile automatically enabled all log domains.\nThis can be useful when rofi is launched from a window manager.\n\n## Creating a backtrace\n\nFirst make sure you compile **rofi** with debug symbols:\n\n```bash\nmake CFLAGS=\"-O0 -g3\" clean rofi\n```\n\nGetting a backtrace using GDB is not very handy. Because if rofi get stuck, it\ngrabs keyboard and mouse. So if it crashes in GDB you are stuck. The best way\nto go is to enable core file. (ulimit -c unlimited in bash) then make rofi\ncrash. You can then load the core in GDB.\n\n```bash\ngdb rofi core\n```\n\nThen type inside gdb:\n\n```bash\nthread apply all bt\n```\n\nThe output trace is useful when reporting crashes.\n\nSome distribution have `systemd-coredump`, this way you can easily get a\nbacktrace via `coredumpctl`.\n\n## SEE ALSO\n\nrofi-sensible-terminal(1), dmenu(1), rofi-theme(5),\nrofi-script(5), rofi-keys(5),rofi-theme-selector(1)\n\n## AUTHOR\n\n* Qball Cow \n" }, { "path": "doc/rofi-dmenu.5.markdown", "content": "# rofi-dmenu(5)\n\n## NAME\n\n**rofi dmenu mode** - Rofi dmenu emulation\n\n## DESCRIPTION\n\nTo integrate **rofi** into scripts as simple selection dialogs, \n**rofi** supports emulating **dmenu(1)** (A dynamic menu for X11).\n\nThe website for `dmenu` can be found [here](http://tools.suckless.org/dmenu/).\n\n**rofi** does not aim to be 100% compatible with `dmenu`. There are simply too\nmany flavors of `dmenu`. The idea is that the basic usage command-line flags\nare obeyed, theme-related flags are not. Besides, **rofi** offers some extended\nfeatures (like multi-select, highlighting, message bar, extra key bindings).\n\n## BASIC CONCEPT\n\nIn `dmenu` mode, **rofi** reads data from standard in, splits them into\nseparate entries and displays them. If the user selects a row, this is printed\nout to standard out, allowing the script to process it further.\n\nBy default separation of rows is done on new lines, making it easy to pipe the\noutput a one application into **rofi** and the output of rofi into the next.\n\n## USAGE \n\nBy launching **rofi** with the `-dmenu` flag it will go into dmenu emulation\nmode.\n\n```bash\nls | rofi -dmenu\n```\n\n### DMENU DROP-IN REPLACEMENT\n\nIf `argv[0]` (calling command) is dmenu, **rofi** will start in dmenu mode.\nThis way, it can be used as a drop-in replacement for dmenu. Just copy or\nsymlink **rofi** to dmenu in `$PATH`.\n\n```bash\nln -s /usr/bin/rofi /usr/bin/dmenu\n```\n\n### DMENU VS SCRIPT MODE\n\nScript mode is used to extend **rofi**, dmenu mode is used to extend a script.\nThe two do share much of the same input format. Please see the\n**rofi-script(5)** manpage for more information.\n\n### DMENU SPECIFIC COMMANDLINE FLAGS\n\nA lot of these options can also be modified by the script using special input.\nSee the **rofi-script(5)** manpage for more information about this syntax.\n\n`-sep` *separator*\n\nSeparator for `dmenu`. Example: To show a list of 'a' to 'e' with '|' as a\nseparator:\n\n```bash\necho \"a|b|c|d|e\" | rofi -sep '|' -dmenu\n```\n\n`-p` *prompt*\n\nSpecify the prompt to show in `dmenu` mode. For example, select 'monkey',\na,b,c,d, or e.\n\n```bash\necho \"a|b|c|d|e\" | rofi -sep '|' -dmenu -p \"monkey\"\n```\n\nDefault: *dmenu*\n\n`-l` *number of lines to show*\n\nMaximum number of lines the menu may show before scrolling.\n\n```bash\nrofi -dmenu -l 25\n```\n\nDefault: *15*\n\n`-i`\n\nMakes `dmenu` searches case-insensitive\n\n`-a` *X*\n\nActive row, mark *X* as active. Where *X* is a comma-separated list of\npython(1)-style indices and ranges, e.g. indices start at 0, -1 refers to the\nlast row with -2 preceding it, ranges are left-open and right-close, and so on.\nYou can specify:\n\n- A single row: '5'\n- A range of (last 3) rows: '-3:'\n- 4 rows starting from row 7: '7:11' (or in legacy notation: '7-10')\n- A set of rows: '2,0,-9'\n- Or any combination: '5,-3:,7:11,2,0,-9'\n\n`-u` *X*\n\nUrgent row, mark *X* as urgent. See `-a` option for details.\n\n`-only-match`\n\nOnly return a selected item, do not allow custom entry.\nThis mode always returns an entry. It will not return if no matching entry is\nselected.\n\n`-no-custom`\n\nOnly return a selected item, do not allow custom entry.\nThis mode returns directly when no entries given.\n\n`-format` *format*\n\nAllows the output of dmenu to be customized (N is the total number of input\nentries):\n\n- 's' selected string\n- 'i' index (0 - (N-1))\n- 'd' index (1 - N)\n- 'q' quote string\n- 'p' Selected string stripped from Pango markup (Needs to be a valid string)\n- 'f' filter string (user input)\n- 'F' quoted filter string (user input)\n\nDefault: 's'\n\n`-select` *string*\n\nSelect first line that matches the given string\n\n`-mesg` *string*\n\nAdd a message line below the filter entry box. Supports Pango markup. For more\ninformation on supported markup, see\n[here](https://docs.gtk.org/Pango/pango_markup.html)\n\n`-dump`\n\nDump the filtered list to stdout and quit.\nThis can be used to get the list as **rofi** would filter it.\nUse together with `-filter` command.\n\n`-input` *file*\n\nReads from *file* instead of stdin.\n\n`-password`\n\nHide the input text. This should not be considered secure!\n\n`-markup-rows`\n\nTell **rofi** that DMenu input is Pango markup encoded, and should be rendered.\nSee [here](https://docs.gtk.org/Pango/pango_markup.html)\nfor details about Pango markup.\n\n`-multi-select`\n\nAllow multiple lines to be selected. Adds a small selection indicator to the\nleft of each entry.\n\n`-sync`\n\nForce **rofi** mode to first read all data from stdin before showing the\nselection window. This is original dmenu behavior.\n\nNote: the default asynchronous mode will also be automatically disabled if used\nwith conflicting options,\nsuch as `-dump`, `-only-match` or `-auto-select`.\n\n`-window-title` *title*\n\nSet name used for the window title. Will be shown as Rofi - *title*\n\n`-w` *windowid*\n\nPosition **rofi** over the window with the given X11 window ID.\n\n`-keep-right`\n\nSet ellipsize mode to start. So, the end of the string is visible.\n\n`-display-columns`\n\nA comma seperated list of columns to show.\n\n`-display-column-separator`\n\nThe column separator. This is a regex. \n\n*default*: '\\t'\n\n`-ballot-selected-str` *string*\n\nWhen multi-select is enabled, prefix this string when element is selected.\n\n*default*: \"☑ \"\n\n`-ballot-unselected-str` *string*\n\nWhen multi-select is enabled, prefix this string when element is not selected.\n\n*default*: \"☐ \"\n\n`-ellipsize-mode` (start|middle|end)\n\nSet ellipsize mode on the listview.\n\n*default* \"end\"\n\n## PARSING ROW OPTIONS\n\nExtra options for individual rows can be also set. See the **rofi-script(5)**\nmanpage for details; the syntax and supported features are identical.\n\n## RETURN VALUE\n\n- **0**: Row has been selected accepted by user.\n- **1**: User cancelled the selection.\n- **10-28**: Row accepted by custom keybinding.\n\n## SEE ALSO\n\nrofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5),\nrofi-theme-selector(1), ascii(7)\n\n## AUTHOR\n\nQball Cow \n\nRasmus Steinke \n\nMorgane Glidic \n\nOriginal code based on work by: Sean Pringle \n\nFor a full list of authors, check the AUTHORS file.\n" }, { "path": "doc/rofi-keys.5.markdown", "content": "# rofi-keys(5)\n\n## NAME\n\n**rofi keys** - Rofi Key and Mouse bindings\n\n## DESCRIPTION\n\n**rofi** supports overriding of any of it key and mouse binding.\n\n## Setting binding\n\nBindings can be done on the commandline (-{bindingname}):\n\n```bash\nrofi -show run -kb-accept-entry 'Control+Shift+space'\n```\n\nor via the configuration file:\n\n```css\nconfiguration {\n kb-accept-entry: \"Control+Shift+space\";\n}\n```\n\nThe key can be set by its name (see above) or its keycode:\n\n```css\nconfiguration {\n kb-accept-entry: \"Control+Shift+[65]\";\n}\n```\n\nAn easy way to look up keycode is xev(1).\n\nMultiple keys can be specified for an action as a comma separated list:\n\n```css\nconfiguration {\n kb-accept-entry: \"Control+Shift+space,Return\";\n}\n```\n\nBy Default **rofi** reacts on pressing, to act on the release of all keys\nprepend the binding with `!`:\n\n```css\nconfiguration {\n kb-accept-entry: \"!Control+Shift+space,Return\";\n}\n```\n\n## Unsetting a binding\n\nTo unset a binding, pass an empty string.\n\n```css\nconfiguration {\n kb-clear-line: \"\";\n}\n```\n\n## Keyboard Bindings\n\n`kb-primary-paste`\n\nPaste primary selection\n\nDefault: Control+V,Shift+Insert\n\n`kb-secondary-paste`\n\nPaste clipboard\n\nDefault: Control+v,Insert\n\n`kb-secondary-copy`\n\nCopy current selection to clipboard\n\nDefault: Control+c\n\n`kb-clear-line`\n\nClear input line\n\nDefault: Control+w\n\n`kb-move-front`\n\nBeginning of line\n\nDefault: Control+a\n\n`kb-move-end`\n\nEnd of line\n\nDefault: Control+e\n\n`kb-move-word-back`\n\nMove back one word\n\nDefault: Alt+b,Control+Left\n\n`kb-move-word-forward`\n\nMove forward one word\n\nDefault: Alt+f,Control+Right\n\n`kb-move-char-back`\n\nMove back one char\n\nDefault: Left,Control+b\n\n`kb-move-char-forward`\n\nMove forward one char\n\nDefault: Right,Control+f\n\n`kb-remove-word-back`\n\nDelete previous word\n\nDefault: Control+Alt+h,Control+BackSpace\n\n`kb-remove-word-forward`\n\nDelete next word\n\nDefault: Control+Alt+d\n\n`kb-remove-char-forward`\n\nDelete next char\n\nDefault: Delete,Control+d\n\n`kb-remove-char-back`\n\nDelete previous char\n\nDefault: BackSpace,Shift+BackSpace,Control+h\n\n`kb-remove-to-eol`\n\nDelete till the end of line\n\nDefault: Control+k\n\n`kb-remove-to-sol`\n\nDelete till the start of line\n\nDefault: Control+u\n\n`kb-transpose-chars`\n\nTranspose (swap) the two characters before the cursor\n\nDefault: Control+t\n\n`kb-accept-entry`\n\nAccept entry\n\nDefault: Control+j,Control+m,Return,KP\\_Enter\n\n`kb-accept-custom`\n\nUse entered text as command (in ssh/run modes)\n\nDefault: Control+Return\n\n`kb-accept-custom-alt`\n\nUse entered text as command (in ssh/run modes)\n\nDefault: Control+Shift+Return\n\n`kb-accept-alt`\n\nUse alternate accept command.\n\nDefault: Shift+Return\n\n`kb-delete-entry`\n\nDelete entry from history\n\nDefault: Shift+Delete\n\n`kb-mode-next`\n\nSwitch to the next mode.\n\nDefault: Shift+Right,Control+Tab\n\n`kb-mode-previous`\n\nSwitch to the previous mode.\n\nDefault: Shift+Left,Control+ISO\\_Left\\_Tab\n\n`kb-mode-complete`\n\nStart completion for mode.\n\nDefault: Control+l\n\n`kb-row-left`\n\nGo to the previous column\n\nDefault: Control+Page\\_Up\n\n`kb-row-right`\n\nGo to the next column\n\nDefault: Control+Page\\_Down\n\n`kb-row-up`\n\nSelect previous entry\n\nDefault: Up,Control+p\n\n`kb-row-down`\n\nSelect next entry\n\nDefault: Down,Control+n\n\n`kb-row-tab`\n\nGo to next row, if one left, accept it, if no left next mode.\n\nDefault:\n\n`kb-element-next`\n\nGo to next row.\n\nDefault: Tab\n\n`kb-element-prev`\n\nGo to previous row.\n\nDefault: ISO\\_Left\\_Tab\n\n`kb-page-prev`\n\nGo to the previous page\n\nDefault: Page\\_Up\n\n`kb-page-next`\n\nGo to the next page\n\nDefault: Page\\_Down\n\n`kb-row-first`\n\nGo to the first entry\n\nDefault: Home,KP\\_Home\n\n`kb-row-last`\n\nGo to the last entry\n\nDefault: End,KP\\_End\n\n`kb-row-select`\n\nSet selected item as input text\n\nDefault: Control+space\n\n`kb-screenshot`\n\nTake a screenshot of the rofi window\n\nDefault: Alt+S\n\n`kb-ellipsize`\n\nToggle between ellipsize modes for displayed data\n\nDefault: Alt+period\n\n`kb-toggle-case-sensitivity`\n\nToggle case sensitivity\n\nDefault: grave,dead\\_grave\n\n`kb-toggle-sort`\n\nToggle filtered menu sort\n\nDefault: Alt+grave\n\n`kb-cancel`\n\nQuit rofi\n\nDefault: Escape,Control+g,Control+bracketleft\n\n`kb-custom-1`\n\nCustom keybinding 1\n\nDefault: Alt+1\n\n`kb-custom-2`\n\nCustom keybinding 2\n\nDefault: Alt+2\n\n`kb-custom-3`\n\nCustom keybinding 3\n\nDefault: Alt+3\n\n`kb-custom-4`\n\nCustom keybinding 4\n\nDefault: Alt+4\n\n`kb-custom-5`\n\nCustom Keybinding 5\n\nDefault: Alt+5\n\n`kb-custom-6`\n\nCustom keybinding 6\n\nDefault: Alt+6\n\n`kb-custom-7`\n\nCustom Keybinding 7\n\nDefault: Alt+7\n\n`kb-custom-8`\n\nCustom keybinding 8\n\nDefault: Alt+8\n\n`kb-custom-9`\n\nCustom keybinding 9\n\nDefault: Alt+9\n\n`kb-custom-10`\n\nCustom keybinding 10\n\nDefault: Alt+0\n\n`kb-custom-11`\n\nCustom keybinding 11\n\nDefault: Alt+exclam\n\n`kb-custom-12`\n\nCustom keybinding 12\n\nDefault: Alt+at\n\n`kb-custom-13`\n\nCustom keybinding 13\n\nDefault: Alt+numbersign\n\n`kb-custom-14`\n\nCustom keybinding 14\n\nDefault: Alt+dollar\n\n`kb-custom-15`\n\nCustom keybinding 15\n\nDefault: Alt+percent\n\n`kb-custom-16`\n\nCustom keybinding 16\n\nDefault: Alt+dead\\_circumflex\n\n`kb-custom-17`\n\nCustom keybinding 17\n\nDefault: Alt+ampersand\n\n`kb-custom-18`\n\nCustom keybinding 18\n\nDefault: Alt+asterisk\n\n`kb-custom-19`\n\nCustom Keybinding 19\n\nDefault: Alt+parenleft\n\n`kb-select-1`\n\nSelect row 1\n\nDefault: Super+1\n\n`kb-select-2`\n\nSelect row 2\n\nDefault: Super+2\n\n`kb-select-3`\n\nSelect row 3\n\nDefault: Super+3\n\n`kb-select-4`\n\nSelect row 4\n\nDefault: Super+4\n\n`kb-select-5`\n\nSelect row 5\n\nDefault: Super+5\n\n`kb-select-6`\n\nSelect row 6\n\nDefault: Super+6\n\n`kb-select-7`\n\nSelect row 7\n\nDefault: Super+7\n\n`kb-select-8`\n\nSelect row 8\n\nDefault: Super+8\n\n`kb-select-9`\n\nSelect row 9\n\nDefault: Super+9\n\n`kb-select-10`\n\nSelect row 10\n\nDefault: Super+0\n\n`kb-entry-history-up`\n\nGo up in the entry history.\n\nDefault: Control+Up\n\n`kb-entry-history-down`\n\nGo down in the entry history.\n\nDefault: Control+Down\n\n`kb-matcher-up`\n\nSelect the next matcher.\n\nDefault: Super+equal\n\n`kb-matcher-down`\n\nSelect the previous matcher.\n\nDefault: Super+minus\n\n## Mouse Bindings\n\n`ml-row-left`\n\nGo to the previous column\n\nDefault: ScrollLeft\n\n`ml-row-right`\n\nGo to the next column\n\nDefault: ScrollRight\n\n`ml-row-up`\n\nSelect previous entry\n\nDefault: ScrollUp\n\n`ml-row-down`\n\nSelect next entry\n\nDefault: ScrollDown\n\n`me-select-entry`\n\nSelect hovered row\n\nDefault: MousePrimary\n\n`me-accept-entry`\n\nAccept hovered row\n\nDefault: MouseDPrimary\n\n`me-accept-custom`\n\nAccept hovered row with custom action\n\nDefault: Control+MouseDPrimary\n\n## Mouse key bindings\n\nThe following mouse buttons can be bound:\n\n* `Primary`: Primary (Left) mouse button click.\n* `Secondary`: Secondary (Right) mouse button click.\n* `Middle`: Middle mouse button click.\n* `Forward`: The forward mouse button.\n* `Back`: The back mouse button.\n* `ExtraN`: The N'the mouse button. (Depending on mouse support).\n\nThe Identifier is constructed as follow:\n\n`Mouse