summaryrefslogtreecommitdiff
path: root/README.org
AgeCommit message (Collapse)Author
2026-01-08docs(macos): expand FAQ for pkg-config/poppler build issuesHEADmasterVedang Manerikar
Add comprehensive troubleshooting steps for macOS users who encounter 'Package poppler not found' or 'gpgmepp not found' errors when building epdfinfo. The root cause is often a non-Homebrew pkg-config (e.g., from Anaconda) shadowing Homebrew's version. Includes: - Diagnostic step to identify which pkg-config is in use - Command-line fix using PKG_CONFIG environment variable - Emacs Lisp snippet for users building via M-x pdf-tools-install Closes #299
2026-01-01doc: add continuous scroll mode documentation to READMEVedang Manerikar
Document the new pdf-view-roll-minor-mode feature: - Explain it's experimental and off by default - How to enable it (M-x pdf-view-roll-minor-mode) - What it does (multiple pages, smooth scrolling) - How to enable by default via hook - Customization options (margin size and color) - Warning about experimental status
2025-12-31chore: replace circleci and appveyor badges with github actions badgeVedang Manerikar
2025-12-30doc: update README based on common queriesVedang Manerikar
2025-12-28doc: mention cask in installation instructionsCalum Freeman
Update install instructions Include prerequisites instructions make path for pdf-tools cleaner (command can now be run without editing the path)
2025-12-28feat: set slice to common bounding box (closes #325)Tamas K. Papp
Fixes #325.
2025-12-28docs: add GNU Guix installationFelix Dumbeck
2023-06-11Update NEWS with recent contributionsVedang Manerikar
The goal is to try and keep these updates as close to when I merge the changes as possible, since they become unmanageable if you wait until the day of the release. I want to acknowledge all the amazing people people who are contributing to `pdf-tools` and making it the powerhouse it is.
2023-06-10Add an FAQ on re-compiling epdfinfoVedang Manerikar
When poppler changes on the system, epdfinfo needs to be recompiled. Mention this in the README.
2023-06-10Fix: href styles in README.orgVedang Manerikar
The current href style was not working on Github, which is really irritating. This commit fixes the issue. Closes: #198
2023-01-17Add a dedicated rotation command and keybindingVisuwesh
We need a dedicated command for rotation since when `pdf-tools` redisplays the image, the `:rotation` image-property is lost. Pdf-tools redisplays the images when changing pages, zooming in/out, setting the slice, etc. so this is essential to have. A variable is used simply because `pdf-tools` already uses a variable to keep track of the current scaling. * lisp/pdf-view.el (pdf-view--current-rotation): Add new variable to keep track of angle. (pdf-view-create-page): Account for above. (pdf-view-mode-map): Add the new command under "R". (pdf-view-rotate): Add new command. Fixes: #152 Closes: #165
2022-12-02Add bug report issue template details to the READMEVedang Manerikar
This lets me push the template to the wiki as well, which I think is useful. Also, note down tasks to help improving reporting in the TODO file.
2022-11-25autobuild: Recognize NetBSD and install packages via pkginfeature/emacs-26.3Sunil Nimmagadda
Closes: #170
2022-11-25Update and cleanup the Install sectionVedang Manerikar
Simplify the instructions and ask users to use `make` where possible! Closes: #160
2022-11-25Render crisp images for HiDPI screens by defaultVedang Manerikar
Copying from the README: > `pdf-tools` version `1.1.0` release changed the default value of > `pdf-view-use-scaling` to `t` (previously, it was `nil`). This has > been done keeping in mind that most modern monitors are HiDPI > screens, so the default configuration should cater to this user. If > you are not using a HiDPI screen, you might have to change this > value to `nil` in your configuration. Closes: #133
2022-10-03Add non-transparent text selection to known problemsorgtre
Including a function which implements a work-around.
2022-07-20Test and Documentation changes: dockerfiles and readmeVedang Manerikar
README changes: - Add documentation on how to test / add support for your favorite operating system. Dockerfile changes: - Rename Dockerfile.in to Dockerfile.common.in, to make the name clearer. - Add make as a prerequisite in the Dockerfile. + It is needed to run make commands and is not available in some of these images. - Add make targets for printing operating systems that are not yet supported in Docker testing. + This should help contributors with adding support for testing on these systems. + New targets are `server-test-supported` and `server-test-unsupported` at the top level. Related to: #130
2022-06-19Minor README change: Remove instruction to install let-alistVedang Manerikar
`let-alist` is available by default in Emacs >=25.2
2022-05-21Remove usage of all private poppler headers in pdf-toolsPi-Cla
This commit also removes C++ entirely, as it is not needed anymore for correct compilation of `epdfinfo`. The following changes are made: - Remove private headers from all the server code. This involves: - Replace private header functionality with the correct public functions provided by poppler. - Remove unneeded headers around date checks - Delete dead-code (headers, m4 macros) - Remove C++, g++ and similar aliases from all the code. Also: - Remove related information from the README - Remove related information from CI and Dockerfiles Work done by: @Pi-Cla Closes: #105, #103, #109, #114
2022-05-09Add an FAQ on running tests locallyVedang Manerikar
This addresses the question of getting immediate feedback on the changes that a developer is making. Of course, the test-suite itself is not extensive and needs to be added to. We will get to it, slow and steady. Related to: #105
2022-05-09Add FAQ explaining workaround for M1 Mac compilation problemsVedang Manerikar
In short, the problem is that many people are using Emacs compiled for x86_64 on the M1 Mac, which is an ARM64 architecture. There is nothing that `pdf-tools` can do here, but the "fix" is straightforward: Install Emacs from https://emacsformacosx.com/, which is compiled correctly. Related to: politza/pdf-tools#652, #70 Closes: #107
2022-04-26Add to PKG_CONFIG_PATH, instead of replacing it.Vedang Manerikar
This is a better solution as it takes into account paths that have already been set up by users. Potentially fixes: #70
2022-04-25Add FAQ on supporting pdf-tools on your favorite OSVedang Manerikar
Along with adding instructions to the README, I'd like people to make changes to the `autobuild` script. Adding this FAQ to help people learn how to do that. Relates to: #92
2022-04-25Update the Emacs minimum supported version in READMEVedang Manerikar
With the release of Emacs 28, we are dropping support for Emacs 24 and 25 (`pdf-tools` is adopting the policy to support on the latest 3 Emacs major versions). This commit simply changes the README file, no actual change in the code has been made yet. I'll make the code changes as part of work towards the 1.0.0 release milestone. Relates to: #26
2022-04-25Clarify Fedora prereqs in the READMEPi-Cla
Closes: #92
2022-04-25Add epdfinfo prereqs for openSUSE in the READMEPi-Cla
Capture requirements for openSUSE Tumbleweed, Leap and MicroOS.
2022-02-13Minor improvements in the installation section of the READMEVedang Manerikar
This should ideally have been part of the previous section, but well, we can't have Gerrit everywhere unfortunately.
2022-02-13Re-arrange server installation instructionsVedang Manerikar
Mention pre-built binaries provided by Debian, Ubuntu and MingW Closes: #79
2022-02-13Mention pre-built Windows binaries in READMEAndrás Svraka
This commit explains how to use the available pre-built binaries for `pdf-tools-server` for MSYS2-MINGW to ease installation on Windows. Currently the MINGW package is outdated but an update is in the works. Progress can be tracked at: msys2/MINGW-packages#10640 Closes: politza/pdf-tools#599 Closes: #77
2022-01-06Fix: link to demo videoVedang Manerikar
2022-01-03Add `display-line-numbers-mode` to Known ProblemsVedang Manerikar
Squashed commit. Author: LuisFCOliveira <67265998+LuisFCOliveira@users.noreply.github.com> Closes: politza#684
2022-01-02Add a link to the PDF Tools Wiki to the READMEVedang Manerikar
The PDF Tools Wiki is live! The plan is to build this into a wonderful self-serve website.
2022-01-02Prepare the README for setting up a wiki siteVedang Manerikar
Clean it up a little bit more. The file, as it is in this commit, has been used for the first export to https://pdftools.wiki 🥂💥 Relates to: #38
2021-12-31Clean up installation instructions in the READMEVedang Manerikar
- Make the headings clearer - Remove repetitive instructions
2021-12-31Use `l` and `r` for backward / forward in history.Vedang Manerikar
`l` and `r` are the conventional bindings for history navigation. The previous key-bindings `B` and `N` are kept as-is for people who were used to it. This is a breaking change because `r` was previously bound to `revert-buffer`. However, `g` is also bound to `revert-buffer` and is the conventional binding for `revert` so this should be okay. Fixes: #43
2021-12-31Add NonGNU ELPA badge to README.orgStefan Kangas
Closes: #63
2021-12-31Clean up and re-organize the READMEVedang Manerikar
This is the first step in the process of creating a documentation site and wiki. Relates to: #38 Closes: #40
2021-05-30Add known conflict with sublimity packagethistle
Closes politza/pdf-tools#674
2021-05-25Improve naming and capitalization in READMERudolf Adamkovič
2021-04-11Add CircleCI and Appveyor badges to READMEVedang Manerikar
Closes #5 :)
2021-04-11Fix: Download missing dll files separatelyVedang Manerikar
I'm making these changes based on reading through the output logs of the Appveyor code, I don't have any understanding of how mingw64 works.
2021-04-11Replace the Travis badge with a CircleCI badgeVedang Manerikar
Also, add my name as a maintainer for this library.
2021-02-20Indentation fixesVedang Manerikar
2019-01-07Update version in FreeBSD package installation commandJoseph Mingrone
The old package, pdf-tools-emacs25, no longer exists.
2018-10-19Fix typoAndreas Politz
2018-10-18Add instructions for Alpine LinuxCleberson Ramirio
2018-10-08Add a new, faster procedure for loading this packageAndreas Politz
2018-07-18README.org: is this a typo?fan
It shows that <F> is bind to 'pdf-links-action-perform, <N> is bind to 'pdf-history-forward, <B> is bind to 'pdf-history-backward, so maybe "History Back / Forwards" should be "B / N" instead of "B / F"?
2018-04-29Remove non-functional appveyor build badgeAndreas Politz
2018-04-29Add appveyor build badgeAndreas Politz