daniel/emacs
1
2
Fork 0
Code Issues 7 Pull Requests Projects Releases Wiki Activity

update of packages

Browse Source
This commit is contained in:
Daniel Weschke
2023-11-04 19:26:41 +01:00
parent e162a12b58
commit 3b54a3236d
726 changed files with 297673 additions and 34585 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
lisp/pdf-tools/README
View File

@@ -11,47 +11,54 @@
The ~pdf-tools~ Wiki is maintained at https://pdftools.wiki. Head to the site if you find it easier to navigate a website for reading a manual. All the topics on the site are listed at https://pdftools.wiki/impulse.
* Table of Contents :noexport:TOC_3_org:
- [[About PDF Tools][About PDF Tools]]
- [[Installing pdf-tools][Installing pdf-tools]]
- [[Installing the epdfinfo server][Installing the epdfinfo server]]
- [[Installing the epdfinfo server from package managers][Installing the epdfinfo server from package managers]]
- [[Installing the epdfinfo server from source on Windows (+ Gotchas)][Installing the epdfinfo server from source on Windows (+ Gotchas)]]
- [[Installing the epdfinfo server from source on macOS (+ Gotchas)][Installing the epdfinfo server from source on macOS (+ Gotchas)]]
- [[Common installation gotchas][Common installation gotchas]]
- [[Installing optional features][Installing optional features]]
- [[Installing pdf-tools elisp code][Installing pdf-tools elisp code]]
- [[Updating pdf-tools][Updating pdf-tools]]
- [[Features][Features]]
- [[View and Navigate PDFs][View and Navigate PDFs]]
- [[Keybindings for navigating PDF documents][Keybindings for navigating PDF documents]]
- [[Keybindings for manipulating display of PDF][Keybindings for manipulating display of PDF]]
- [[Annotations][Annotations]]
- [[Keybindings for working with Annotations][Keybindings for working with Annotations]]
- [[Working with AUCTeX][Working with AUCTeX]]
- [[Keybindings for working with AUCTeX][Keybindings for working with AUCTeX]]
- [[Miscellaneous features][Miscellaneous features]]
- [[Keybindings for miscellaneous features in PDF tools][Keybindings for miscellaneous features in PDF tools]]
- [[Easy Help for PDF Tools features][Easy Help for PDF Tools features]]
- [[Configuring PDF Tools features][Configuring PDF Tools features]]
- [[Known problems][Known problems]]
- [[linum-mode][linum-mode]]
- [[display-line-numbers-mode][display-line-numbers-mode]]
- [[auto-revert][auto-revert]]
- [[sublimity][sublimity]]
- [[Text selection is not transparent in PDFs OCRed with Tesseract][Text selection is not transparent in PDFs OCRed with Tesseract]]
- [[Key-bindings in PDF Tools][Key-bindings in PDF Tools]]
- [[Tips and Tricks for Developers][Tips and Tricks for Developers]]
- [[Turn on debug mode][Turn on debug mode]]
- [[Run Emacs lisp tests locally][Run Emacs lisp tests locally]]
- [[Run server compilation tests locally][Run server compilation tests locally]]
- [[Add a Dockerfile to automate server compilation testing][Add a Dockerfile to automate server compilation testing]]
- [[FAQs][FAQs]]
- [[PDFs are not rendering well!][PDFs are not rendering well!]]
- [[What Emacs versions does pdf-tools support?][What Emacs versions does pdf-tools support?]]
- [[I want to add support for pdf-tools on "My Fav OS". How do I do that?][I want to add support for pdf-tools on "My Fav OS". How do I do that?]]
- [[I am on a Macbook M1 and pdf-tools installation fails with a stack-trace][I am on a Macbook M1 and pdf-tools installation fails with a stack-trace]]
- [[I am a developer, making changes to the pdf-tools source code][I am a developer, making changes to the pdf-tools source code]]
* Table of Contents :noexport:TOC_3_gh:
- [[#about-pdf-tools][About PDF Tools]]
- [[#installing-pdf-tools][Installing pdf-tools]]
- [[#installing-the-epdfinfo-server][Installing the epdfinfo server]]
- [[#installing-the-epdfinfo-server-from-package-managers][Installing the epdfinfo server from package managers]]
- [[#installing-the-epdfinfo-server-from-source-on-windows--gotchas][Installing the epdfinfo server from source on Windows (+ Gotchas)]]
- [[#installing-the-epdfinfo-server-from-source-on-macos--gotchas][Installing the epdfinfo server from source on macOS (+ Gotchas)]]
- [[#common-installation-gotchas][Common installation gotchas]]
- [[#installing-optional-features][Installing optional features]]
- [[#installing-pdf-tools-elisp-code][Installing pdf-tools elisp code]]
- [[#updating-pdf-tools][Updating pdf-tools]]
- [[#features][Features]]
- [[#view-and-navigate-pdfs][View and Navigate PDFs]]
- [[#keybindings-for-navigating-pdf-documents][Keybindings for navigating PDF documents]]
- [[#keybindings-for-manipulating-display-of-pdf][Keybindings for manipulating display of PDF]]
- [[#annotations][Annotations]]
- [[#keybindings-for-working-with-annotations][Keybindings for working with Annotations]]
- [[#working-with-auctex][Working with AUCTeX]]
- [[#keybindings-for-working-with-auctex][Keybindings for working with AUCTeX]]
- [[#miscellaneous-features][Miscellaneous features]]
- [[#keybindings-for-miscellaneous-features-in-pdf-tools][Keybindings for miscellaneous features in PDF tools]]
- [[#easy-help-for-pdf-tools-features][Easy Help for PDF Tools features]]
- [[#configuring-pdf-tools-features][Configuring PDF Tools features]]
- [[#known-problems][Known problems]]
- [[#linum-mode][linum-mode]]
- [[#display-line-numbers-mode][display-line-numbers-mode]]
- [[#auto-revert][auto-revert]]
- [[#sublimity][sublimity]]
- [[#text-selection-is-not-transparent-in-pdfs-ocred-with-tesseract][Text selection is not transparent in PDFs OCRed with Tesseract]]
- [[#key-bindings-in-pdf-tools][Key-bindings in PDF Tools]]
- [[#tips-and-tricks-for-developers][Tips and Tricks for Developers]]
- [[#turn-on-debug-mode][Turn on debug mode]]
- [[#run-emacs-lisp-tests-locally][Run Emacs lisp tests locally]]
- [[#run-server-compilation-tests-locally][Run server compilation tests locally]]
- [[#add-a-dockerfile-to-automate-server-compilation-testing][Add a Dockerfile to automate server compilation testing]]
- [[#issue-template-for-bug-reports][Issue Template for Bug Reports]]
- [[#describe-the-bug][Describe the bug]]
- [[#steps-to-reproduce-the-behaviour][Steps To Reproduce the behaviour:]]
- [[#what-is-the-expected-behaviour][What is the expected behaviour?]]
- [[#desktop][Desktop]]
- [[#your-pdf-tools-install][Your pdf-tools install]]
- [[#additional-context][Additional context]]
- [[#faqs][FAQs]]
- [[#pdfs-are-not-rendering-well][PDFs are not rendering well!]]
- [[#what-emacs-versions-does-pdf-tools-support][What Emacs versions does pdf-tools support?]]
- [[#i-want-to-add-support-for-pdf-tools-on-my-fav-os-how-do-i-do-that][I want to add support for pdf-tools on "My Fav OS". How do I do that?]]
- [[#i-am-on-a-macbook-m1-and-pdf-tools-installation-fails-with-a-stack-trace][I am on a Macbook M1 and pdf-tools installation fails with a stack-trace]]
- [[#i-am-a-developer-making-changes-to-the-pdf-tools-source-code][I am a developer, making changes to the pdf-tools source code]]
* About PDF Tools
:PROPERTIES:
@@ -218,7 +225,7 @@ This also applies when updating via MELPA / NonGNU ELPA (except for running the
+ Follow :: Click on highlighted links, moving to some part of a different page, some external file, a website or any other URI. Links may also be followed by keyboard commands.
+ Annotations :: Display and list text and markup annotations (like underline), edit their contents and attributes (e.g. color), move them around, delete them or create new ones and then save the modifications back to the PDF file. [[id:5fff6471-a933-46d7-8ae9-b2fa4a9de952][More information here]].
+ Attachments :: Save files attached to the PDF-file or list them in a dired buffer.
+ Outline :: Use ~imenu~ or a special buffer (~M-x pdf-outline~) to examine and navigate the PDF's outline.
+ Outline :: Use ~imenu~ or a special buffer (=M-x pdf-outline=) to examine and navigate the PDF's outline.
+ SyncTeX :: Jump from a position on a page directly to the TeX source and vice versa.
+ Virtual :: Use a collection of documents as if it were one, big single PDF.
+ Misc ::
@@ -288,6 +295,8 @@ Note that ~pdf-tools~ renders the PDF as images inside Emacs. This means that al
| Trim Margins (set slice to bounding box) | ~s b~ |
| Reset Margins | ~s r~ |
| Reset Zoom | ~0~ |
| Rotate Page | ~R~ |
|------------------------------------------+-----------------|
** Annotations
:PROPERTIES:
@@ -300,27 +309,30 @@ Note that ~pdf-tools~ renders the PDF as images inside Emacs. This means that al
:CREATED: [2021-12-30 Thu 17:08]
:ID: 243b3843-b912-430b-884a-641304755b92
:END:
| Annotations | |
|--------------------------------------+---------------------------------------------------|
| List Annotations | ~C-c C-a l~ |
| Jump to Annotations from List | ~SPACE~ |
| Mark Annotation for Deletion | ~d~ |
| Delete Marked Annotations | ~x~ |
| Unmark Annotations | ~u~ |
| Close Annotation List | ~q~ |
| Enable/Disable Following Annotations | ~C-c C-f~ |
|--------------------------------------+---------------------------------------------------|
| Add and Edit Annotations | Select region via Mouse selection. |
| | Then left-click context menu OR keybindings below |
|--------------------------------------+---------------------------------------------------|
| Add a Markup Annotation | ~C-c C-a m~ |
| Add a Highlight Markup Annotation | ~C-c C-a h~ |
| Add a Strikeout Markup Annotation | ~C-c C-a o~ |
| Add a Squiggly Markup Annotation | ~C-c C-a s~ |
| Add an Underline Markup Annotation | ~C-c C-a u~ |
| Add a Text Annotation | ~C-c C-a t~ |
|--------------------------------------+---------------------------------------------------|
| | |
| Annotations | |
|--------------------------------------+----------------------------------------------------|
| List Annotations | ~C-c C-a l~ |
| Jump to Annotations from List | ~SPACE~ |
| Mark Annotation for Deletion | ~d~ |
| Delete Marked Annotations | ~x~ |
| Unmark Annotations | ~u~ |
| Close Annotation List | ~q~ |
| Enable/Disable Following Annotations | ~C-c C-f~ |
|--------------------------------------+----------------------------------------------------|
| Add and Edit Annotations | Select region via Mouse selection. |
| | Then left-click context menu OR keybindings below |
|--------------------------------------+----------------------------------------------------|
| Add a Markup Annotation | ~C-c C-a m~ |
| Add a Highlight Markup Annotation | ~C-c C-a h~ |
| Add a Strikeout Markup Annotation | ~C-c C-a o~ |
| Add a Squiggly Markup Annotation | ~C-c C-a s~ |
| Add an Underline Markup Annotation | ~C-c C-a u~ |
| Add a Text Annotation | ~C-c C-a t~ |
|--------------------------------------+----------------------------------------------------|
| Highlight an arbitrary region | Section region with Mouse Drag (Hold down Meta and |
| | drag). Then ~C-c C-a h~ to highlight that region. |
|--------------------------------------+----------------------------------------------------|
| | |
** Working with AUCTeX
:PROPERTIES:
@@ -361,7 +373,7 @@ Note that ~pdf-tools~ renders the PDF as images inside Emacs. This means that al
M-x pdf-tools-help RET
#+end_src
Run ~M-x pdf-tools-help~ inside Emacs, as shown above. It will list all the features provided by ~pdf-tools~ as well as the key-bindings for these features.
Run =M-x pdf-tools-help= inside Emacs, as shown above. It will list all the features provided by ~pdf-tools~ as well as the key-bindings for these features.
** Configuring PDF Tools features
:PROPERTIES:
@@ -520,12 +532,12 @@ A clear and concise description of what you expected to happen.
Please complete the following information:
- OS: [eg: MacOS Catalina]
- Emacs Version: [This should be the output of ~M-x emacs-version~ ]
- Emacs Version: [This should be the output of =M-x emacs-version= ]
- Poppler Version: [eg: output of ~brew info poppler~ and similarly for other OSs]
*** Your pdf-tools install
Please complete the following information:
- ~pdf-tools~ Version: [ ~M-x package-list-packages~ -> Search for ~pdf-tools~ -> Hit Enter and copy all the details that pop up in the Help buffer]
- ~pdf-tools~ Version: [ =M-x package-list-packages= -> Search for ~pdf-tools~ -> Hit Enter and copy all the details that pop up in the Help buffer]
- ~pdf-tools~ customization / configuration that you use:
*** Additional context
@@ -539,6 +551,13 @@ Please complete the following information:
:CREATED: [2021-12-30 Thu 22:04]
:ID: 3be6abe7-163e-4c3e-a7df-28e8470fe37f
:END:
** Epdfinfo has stopped working!
:PROPERTIES:
:CREATED: [2023-06-10 Sat 23:25]
:ID: 9B5F797F-9BB3-45D9-B364-D4E5F13222BF
:END:
Have you upgraded ~poppler~ recently? This can cause ~epdfinfo~ to stop working, since it was compiled with the previous version of ~poppler~. Just run =M-x pdf-tools-install= and this should be fixed.
** PDFs are not rendering well!
:PROPERTIES:
:CREATED: [2021-12-30 Thu 22:04]
@@ -558,6 +577,7 @@ to scale the images correctly when rendering them.
:ID: f44c66e6-402d-4154-b806-6bb4180a0a5b
:END:
~pdf-tools~ supports the 3 latest versions of Emacs major releases. At the moment of this writing, this means that the minimum supported Emacs version is ~26.3~.
** I want to add support for pdf-tools on "My Fav OS". How do I do that?
:PROPERTIES:
:CREATED: [2022-04-25 Mon 21:50]
@@ -581,7 +601,7 @@ When you make your changes, please be sure to test [[id:1CBE7325-A5A1-479B-9A98-
:CREATED: [2022-05-09 Mon 20:29]
:ID: 96D389D8-DD23-4FB0-996C-2D6F70A76BB2
:END:
There have been a number of issues around ~pdf-tools~ installation problems on M1. ~M-x pdf-tools-install~ throws the following stack trace:
There have been a number of issues around ~pdf-tools~ installation problems on M1. =M-x pdf-tools-install= throws the following stack trace:
#+begin_example
1 warning generated.
ld: warning: ignoring file /opt/homebrew/opt/gettext/lib/libintl.dylib, building for macOS-x86_64 but attempting to link with file built for macOS-arm64