emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/pdf-tools 5621164d47 3/3: Clean up installation instructio


From: ELPA Syncer
Subject: [nongnu] elpa/pdf-tools 5621164d47 3/3: Clean up installation instructions in the README
Date: Fri, 31 Dec 2021 03:58:41 -0500 (EST)

branch: elpa/pdf-tools
commit 5621164d47b0e59676edad252b514f5c3c15824f
Author: Vedang Manerikar <ved.manerikar@gmail.com>
Commit: Vedang Manerikar <ved.manerikar@gmail.com>

    Clean up installation instructions in the README
    
    - Make the headings clearer
    - Remove repetitive instructions
---
 README.org | 315 +++++++++++++++++++++++--------------------------------------
 1 file changed, 118 insertions(+), 197 deletions(-)

diff --git a/README.org b/README.org
index 8e6adfed7b..dd476ea221 100644
--- a/README.org
+++ b/README.org
@@ -18,121 +18,93 @@ PDF Tools is, among other things, a replacement of DocView 
for PDF files. The ke
 
 This rendering is performed by a special library named, for whatever reason, 
~poppler~, running inside a server program. This program is called ~epdfinfo~ 
and its job is to successively read requests from Emacs and produce the proper 
results, i.e. the PNG image of a PDF page.
 
-Actually, displaying PDF files is just one part of PDF Tools. Since poppler 
can provide us with all kinds of information about a document and is also able 
to modify it, there is a lot more we can do with it. 
[[http://www.dailymotion.com/video/x2bc1is_pdf-tools-tourdeforce_tech?forcedQuality%3Dhd720][Watch]]
-
-Please read also about [[id:4baf936a-2454-41c9-99db-177133ee9568][Known 
problems]]
+Actually, displaying PDF files is just one part of ~pdf-tools~. Since 
~poppler~ can provide us with all kinds of information about a document and is 
also able to modify it, there is a lot more we can do with it. 
[[http://www.dailymotion.com/video/x2bc1is_pdf-tools-tourdeforce_tech?forcedQuality%3Dhd720][Watch
 this video for a detailed demo!]]
 
 * Installation
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       6ceea50c-cbaa-4d8a-b450-8067c5e8c9da
 :END:
-The package may be installed via MELPA and it will try to build the server 
part when it is activated the first time. Though the next section regarding 
build-prerequisites is still relevant, the rest of the installation 
instructions assume a build from within a git repository. (The MELPA package 
has a different directory structure.)
+Installing this package via NonGNU ELPA or MELPA or any of the other package 
managers is straightforward and should just work.
+~pdf-tools~ requires a server ~epdfinfo~ to run against, which it will try to 
compile and build when it is activated for the first time.
 
-** Server prerequisites
+You should not require any manual changes. The documentation below is if you 
are installing from source, or for troubleshooting / debugging purposes.
+** Installing ~epdfinfo~ server prerequisites
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       8ce3cf4e-d186-4de1-a40e-f41063068ab0
 :END:
-    You'll need GNU Emacs \ge 24.3 and some form of a GNU/Linux OS.
-    Other operating systems are currently not supported (patches
-    welcome).  The following instructions assume a Debian-based
-    system. (The prerequisites may be installed automatically on this
-    kind of systems, see [[#compilation][Compilation]] .)
+You'll need GNU Emacs \ge 24.3 and some form of a GNU/Linux OS. Other 
operating systems are not officially supported, but ~pdf-tools~ is known to 
work on many of them. See below for more details. The following instructions 
assume a Debian-based system.
 
-    First make sure a suitable build-system is installed.  We need at
-    least a C/C++ compiler (both ~gcc~ and ~g++~), ~make~, ~automake~
-    and ~autoconf~.
+First make sure a suitable build-system is installed. We need at least a C/C++ 
compiler (both ~gcc~ and ~g++~), ~make~, ~automake~ and ~autoconf~.
 
-    Next we need to install a few libraries PDF Tools depends on, some
-    of which are probably already on your system.
+Next we need to install a few libraries ~pdf-tools~ depends on, some of which 
are probably already on your system.
 #+begin_src sh
-  $ sudo aptitude install libpng-dev zlib1g-dev
-  $ sudo aptitude install libpoppler-glib-dev
-  $ sudo aptitude install libpoppler-private-dev
+  $ sudo apt install libpng-dev zlib1g-dev libpoppler-glib-dev 
libpoppler-private-dev
 #+end_src
-    On some older Ubuntu systems, the final command will possibly give
-    an error.  This should be no problem, since in some versions this
-    package was contained in the main package ~libpoppler-dev~.  Also
-    note, that ~zlib1g-dev~ was for a long time called ~libz-dev~,
-    which it still may be on your system.
-
-    Debian wheezy comes with libpoppler version 0.18, which is pretty
-    old.  The minimally required version is 0.16, but some features of
-    PDF Tools depend on a more recent version of this library.  See
-    the following table for what they are and what version they
-    require.
-
-    | You want to ...                           | Required version |
-    |-------------------------------------------+------------------|
-    | ... create and modify text annotations.   | \ge 0.19.4       |
-    | ... search case-sensitive.                | \ge 0.22         |
-    | ... create and modify markup annotations. | \ge 0.26         |
-    |-------------------------------------------+------------------|
-
-    In case you decide to install libpoppler from source, make sure
-    to run its configure script with the ~--enable-xpdf-headers~
-    option.
-
-    Finally there is one feature (following links of a PDF document by
-    plain keystrokes) which requires imagemagick's convert utility.
-    This requirement is optional and you may install it like so:
+
+On some older Ubuntu systems, the final command will possibly give an error. 
This should be no problem, since in some versions this package was contained in 
the main package ~libpoppler-dev~. Also note, that ~zlib1g-dev~ was for a long 
time called ~libz-dev~, which it still may be on your system.
+
+Debian wheezy comes with ~libpoppler~ version ~0.18~, which is pretty old. The 
minimally required version is ~0.16~, but some features of ~pdf-tools~ depend 
on a more recent version of this library. See the following table for what they 
are and what version they require.
+
+| You want to ...                           | Required version |
+|-------------------------------------------+------------------|
+| ... create and modify text annotations.   | \ge 0.19.4       |
+| ... search case-sensitive.                | \ge 0.22         |
+| ... create and modify markup annotations. | \ge 0.26         |
+|-------------------------------------------+------------------|
+
+In case you decide to install ~libpoppler~ from source, make sure to run its 
configure script with the ~--enable-xpdf-headers~ option.
+
+Finally there is one feature (following links of a PDF document by plain 
keystrokes) which requires imagemagick's convert utility. This requirement is 
optional and you may install it like so:
 #+begin_src sh
-  $ sudo aptitude install imagemagick
+  $ sudo apt install imagemagick
 #+end_src
-*** Compiling on macOS
+*** Installing Server Prerequisites On macOS
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       f10e9d94-bdec-44dc-8d3c-1816d62ef1c4
 :END:
-     Although macOS is not officially supported, it has been reported
-     to have been successfully compiled.  You will need to install
-     poppler which you can get with Homebrew via
+Although macOS is not officially supported, it has been reported that 
~pdf-tools~ works well on macOS. You will need to install ~poppler~ which you 
can get with Homebrew via
 #+BEGIN_SRC sh
   $ brew install poppler automake
 #+END_SRC
 
-     You will also have to help ~pkg-config~ find some libraries by
-     setting ~PKG_CONFIG_PATH~, e.g.
+You will also have to help ~pkg-config~ find some libraries by setting 
~PKG_CONFIG_PATH~, e.g.
 #+BEGIN_SRC sh
   $ export 
PKG_CONFIG_PATH=/usr/local/Cellar/zlib/1.2.8/lib/pkgconfig:/usr/local/lib/pkgconfig:/opt/X11/lib/pkgconfig
 #+END_SRC
-     or likewise within Emacs using `setenv`.
+or likewise within Emacs using ~setenv~.
 
-     After that, compilation should proceed as normal.
-*** FreeBSD
+After that, compilation should proceed as normal.
+*** Installing Server Prerequisites On FreeBSD
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       00faf3e3-6d09-4cf7-9373-838f3d231504
 :END:
-     Although not officially supported, it has been reported that
-     pdf-tools work well on FreeBSD.  Instead of building pdf-tools, you
-     can install one of the OS packages with, e.g.
+Although not officially supported, it has been reported that ~pdf-tools~ work 
well on FreeBSD. Instead of building ~pdf-tools~, you can install one of the OS 
packages with e.g.
 #+BEGIN_SRC sh
   $ pkg install pdf-tools-emacs26
 #+END_SRC
-     To see the current list of pdf-tools packages for FreeBSD visit
-     [[https://repology.org/metapackages/?search=pdf-tools&inrepo=freebsd][the 
Repology list]].
 
-     To build pdf-tools from either MELPA or directly from the source
-     repository, install the dependencies with
+To see the current list of ~pdf-tools~ packages for FreeBSD visit 
[[https://repology.org/metapackages/?search=pdf-tools&inrepo=freebsd][the 
Repology list]].
+
+To build ~pdf-tools~ from either MELPA or directly from the source repository, 
install the dependencies with
 #+BEGIN_SRC sh
   $ pkg install autotools gmake poppler-glib
 #+END_SRC
 
-     If you choose not to install from MELPA, you must substitute
-    ~gmake~ for ~make~ in the instructions below.
-*** Compiling on CentOS
+If you choose not to install from MELPA, you must substitute ~gmake~ for 
~make~ in the instructions below.
+*** Installing Server Prerequisites On CentOS
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       e39946d0-3a28-405d-bb23-337120412dac
 :END:
-     It is possible to compile pdf-tools on CentOS. Install poppler the 
dependencies with:
 #+BEGIN_SRC sh
   $ yum install poppler-devel poppler-glib-devel
 #+END_SRC
 
-*** Compiling on Fedora
+*** Installing Server Prerequisites On Fedora
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       d0013822-f4d0-4354-b3db-c54ffe41ce58
@@ -141,7 +113,7 @@ The package may be installed via MELPA and it will try to 
build the server part
   $ sudo dnf install make automake autoconf gcc gcc-c++ ImageMagick 
libpng-devel zlib-devel poppler-glib-devel
 #+END_SRC
 
-*** Compiling on Alpine Linux
+*** Installing Server Prerequisites On Alpine Linux
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       443d9b18-096e-4770-b59c-4e472a5d4b0e
@@ -150,164 +122,113 @@ The package may be installed via MELPA and it will try 
to build the server part
   $ apk add build-base g++ gcc automake autoconf libpng-dev glib-dev 
poppler-dev
 #+END_SRC
 
-*** Compiling on Windows
+*** Installing Server Prerequisites On Windows
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       005243cb-1557-4f94-a73d-e647e0d4b53d
 :END:
-     PDF Tools can be built and used on Windows using the MSYS2
-     compiler. This will work with native (not cygwin) Windows builds of
-     emacs. This includes the standard binaries provided by the GNU
-     project, those available as MSYS2 packages and numerous third-party
-     binaries. It has been tested with Emacs 25.1. Instructions are
-     provided under [[#compilation-and-installation-on-windows][Compilation 
and installation on Windows]], below.
-     PDF Tools will successfully compile using Cygwin, but it will not be
-     able to open PDFs properly due to the way binaries compiled with Cygwin
-     handle file paths.
-
-** Compilation
-    :PROPERTIES:
-    :CUSTOM_ID: compilation
-    :CREATED:  [2021-12-29 Wed 18:34]
-    :ID:       e305cd0a-e798-4c2b-af27-21bcd936c1c9
-    :END:
-    Now it's time to compile the source.
+~pdf-tools~ can be built and used on Windows using the MSYS2 compiler. This 
will work with native (not cygwin) Windows builds of Emacs. This includes the 
standard binaries provided by the GNU project, those available as MSYS2 
packages and numerous third-party binaries. It has been tested with Emacs 25.1. 
Instructions are provided under 
[[id:d14e01ff-9bd5-47ee-86fc-859b4499d5d7][Compilation and installation on 
Window]] below. ~pdf-tools~ will successfully compile using Cygwin, but it will 
[...]
+
+** Compiling and Installing the ~epdfinfo~ server
+:PROPERTIES:
+:CUSTOM_ID: compilation
+:CREATED:  [2021-12-29 Wed 18:34]
+:ID:       e305cd0a-e798-4c2b-af27-21bcd936c1c9
+:END:
 #+begin_src sh
     $ cd /path/to/pdf-tools
-    $ make install-server-deps # optional
     $ make -s
 #+end_src
-    The ~make install-server-deps~ command will try to install all
-    necessary programs and libraries to build the package, though
-    it'll only work, if ~sudo~ and ~apt-get~ are available.
-
-    This should compile the source code and create a Emacs Lisp
-    Package in the root directory of the project. The configure script
-    also tells you at the very end, which features, depending on the
-    libpoppler version, will be available.  These commands should give
-    no error, otherwise you are in trouble.
-*** Compilation and installation on Windows
-     :PROPERTIES:
-     :CUSTOM_ID: compilation-and-installation-on-windows
-     :CREATED:  [2021-12-29 Wed 18:34]
-     :ID:       d14e01ff-9bd5-47ee-86fc-859b4499d5d7
-     :END:
-      If using the GNU binaries for Windows, support for PNG and zlib
-      must first be installed by copying the appropriate dlls into
-      emacs' ~bin/~ directory. Most third-party binaries come with this
-      already done.
-
-      First, install [[http://www.msys2.org/][install MSYS2]] and update
-      the package database and core packages using the instructions
-      provided. Then, to compile PDF tools itself:
-
-      1. Open msys2 shell
-
-      2. Update and install dependencies, skipping any you already have
-         #+BEGIN_SRC sh
-         $ pacman -Syu
-         $ pacman -S base-devel
-         $ pacman -S mingw-w64-x86_64-toolchain
-         $ pacman -S mingw-w64-x86_64-zlib
-         $ pacman -S mingw-w64-x86_64-libpng
-         $ pacman -S mingw-w64-x86_64-poppler
-         $ pacman -S mingw-w64-x86_64-imagemagick
-         #+END_SRC
-
-      3. Install PDF tools in Emacs, but do not try to compile the
-         server. Instead, get a separate copy of the source somewhere
-         else.
-         #+BEGIN_SRC sh
-         $ git clone https://github.com/politza/pdf-tools
-         #+END_SRC
-
-      4. Open ~mingw64~ shell (*Note:* You must use ~mingw64.exe~ and not 
~msys2.exe~)
-
-      5. Compile pdf-tools
-         #+BEGIN_SRC sh
-         $ cd /path/to/pdf-tools
-         $ make -s
-         #+END_SRC
-
-      6. This should produce a file ~server/epdfinfo.exe~. Copy this file
-         into the ~pdf-tools/~ installation directory in your Emacs.
-
-      7. Start Emacs and activate the package.
-         #+BEGIN_SRC
-         M-x pdf-tools-install RET
-         #+END_SRC
-
-      8. Test.
-         #+BEGIN_SRC
-         M-x pdf-info-check-epdfinfo RET
-         #+END_SRC
-
-      If this is successful, ~(pdf-tools-install)~ can be added to Emacs'
-      config. Note that libraries from other GNU utilities, such as Git
-      for Windows, may interfere with those needed by PDF Tools.
-      ~pdf-info-check-epdinfo~ will succeed, but errors occur when trying
-      to view a PDF file. This can be fixed by ensuring that the MSYS
-      libraries are always preferred in Emacs:
-
- #+BEGIN_SRC emacs-lisp
- (setenv "PATH" (concat "C:\\msys64\\mingw64\\bin;" (getenv "PATH")))
- #+END_SRC
-
-** Elisp prerequisites
+
+This should compile the source code and create a Emacs Lisp Package in the 
root directory of the project. The configure script also tells you at the very 
end, which features, depending on the libpoppler version, will be available. 
These commands should give no error, otherwise you are in trouble.
+*** On Windows
 :PROPERTIES:
+:CUSTOM_ID: compilation-and-installation-on-windows
 :CREATED:  [2021-12-29 Wed 18:34]
-:ID:       3d4e6b6b-f015-475d-8ea2-84988efd6c22
+:ID:       d14e01ff-9bd5-47ee-86fc-859b4499d5d7
 :END:
-    This package depends on the following Elisp packages, which should
-    be installed before installing the PDF Tools package.
+If using the GNU binaries for Windows, support for PNG and ~zlib~ must first 
be installed by copying the appropriate dlls into emacs' ~bin/~ directory. Most 
third-party binaries come with this already done.
 
-    | Package   | Required version                 |
-    |-----------+----------------------------------|
-    | [[https://elpa.gnu.org/packages/let-alist.html][let-alist]] | >= 1.0.4 
(comes with Emacs 25.2) |
-    | [[http://melpa.org/#/tablist][tablist]]   | >= 0.70                      
    |
-    |-----------+----------------------------------|
+First, install [[http://www.msys2.org/][install MSYS2]] and update the package 
database and core packages using the instructions provided. Then, to compile 
~pdf-tools~ itself:
 
-** Installing
+1. Open msys2 shell
+2. Update and install dependencies, skipping any you already have
+#+BEGIN_SRC sh
+$ pacman -Syu
+$ pacman -S base-devel
+$ pacman -S mingw-w64-x86_64-toolchain
+$ pacman -S mingw-w64-x86_64-zlib
+$ pacman -S mingw-w64-x86_64-libpng
+$ pacman -S mingw-w64-x86_64-poppler
+$ pacman -S mingw-w64-x86_64-imagemagick
+#+END_SRC
+3. Install ~pdf-tools~ in Emacs, but do not try to compile the server. 
Instead, get a separate copy of the source somewhere else.
+#+BEGIN_SRC sh
+$ git clone https://github.com/vedang/pdf-tools
+#+END_SRC
+4. Open ~mingw64~ shell (*Note:* You must use ~mingw64.exe~ and not 
~msys2.exe~)
+5. Compile pdf-tools
+#+BEGIN_SRC sh
+$ cd /path/to/pdf-tools
+$ make -s
+#+END_SRC
+6. This should produce a file ~server/epdfinfo.exe~. Copy this file into the 
~pdf-tools/~ installation directory in your Emacs.
+7. Start Emacs and activate the package.
+#+BEGIN_SRC
+M-x pdf-tools-install RET
+#+END_SRC
+8. Test.
+#+BEGIN_SRC
+M-x pdf-info-check-epdfinfo RET
+#+END_SRC
+
+If this is successful, ~(pdf-tools-install)~ can be added to Emacs' config. 
Note that libraries from other GNU utilities, such as Git for Windows, may 
interfere with those needed by ~pdf-tools~. ~pdf-info-check-epdinfo~ will 
succeed, but errors occur when trying to view a PDF file. This can be fixed by 
ensuring that the MSYS libraries are always preferred in Emacs:
+
+#+BEGIN_SRC emacs-lisp
+  (setenv "PATH" (concat "C:\\msys64\\mingw64\\bin;" (getenv "PATH")))
+#+END_SRC
+
+** Installing ~pdf-tools~ elisp prerequisites
+:PROPERTIES:
+:CREATED:  [2021-12-29 Wed 18:34]
+:ID:       3d4e6b6b-f015-475d-8ea2-84988efd6c22
+:END:
+This package depends on the following Elisp packages, which should be 
installed before installing the ~pdf-tools~ package.
+| Package   | Required version                 |
+|-----------+----------------------------------|
+| [[https://elpa.gnu.org/packages/let-alist.html][let-alist]] | >= 1.0.4 
(comes with Emacs 25.2) |
+| [[http://melpa.org/#/tablist][tablist]]   | >= 0.70                          
|
+|-----------+----------------------------------|
+
+** Installing ~pdf-tools~
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       32c4fc3b-b4ea-43bd-b92c-bdf2d3831fcf
 :END:
-    If ~make~ produced the ELP file ~pdf-tools-${VERSION}.tar~ you are
-    fine.  This package contains all the necessary files for Emacs
-    and may be installed by either using
+If ~make~ produced the ELP file ~pdf-tools-${VERSION}.tar~ you are fine. This 
package contains all the necessary files for Emacs and may be installed by 
either using
 #+begin_src sh
     $ make install-package
 #+end_src
-    or executing the Emacs command
+or executing the Emacs command
 #+begin_src elisp
   M-x package-install-file RET pdf-tools-${VERSION}.tar RET
 #+end_src
 
-  To complete the installation process, you need to activate the
-  package by putting
-#+begin_src elisp
-  (pdf-tools-install)
-#+end_src
-  somewhere in your ~.emacs~.  Alternatively, and if you care about
-  start-up time, you may want to use
+To complete the installation process, you need to activate the package by 
putting the code below somewhere in your ~.emacs~.  Alternatively, and if you 
care about startup time, you may want to use the loader version instead.
 #+begin_src elisp
-  (pdf-loader-install)
+  (pdf-tools-install)  ; Standard activation command
+  (pdf-loader-install) ; On demand loading, leads to faster startup time
 #+end_src
-  instead.
 
 Once the Installation process is complete, check out 
[[id:19a3daea-6fa6-4ac3-9201-d2034c46ad8c][Easy Help for PDF Tools features]] 
and [[id:8dccd685-18b8-4c98-977a-0fe2d66b724c][Configuring PDF Tools features]] 
to get started!
-** Updating
+** Updating ~pdf-tools~
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       9dd62314-f5ad-4bd4-83fa-8e28343e3d9c
 :END:
-    Some day you might want to update this package via ~git pull~ and
-    then reinstall it.  Sometimes this may fail, especially if
-    Lisp-Macros are involved and the version hasn't changed.  To avoid
-    this kind of problems, you should delete the old package via
-    ~list-packages~, restart Emacs and then reinstall the package.
+Some day you might want to update this package via ~git pull~ and then 
reinstall it. Sometimes this may fail, especially if Lisp-Macros are involved 
and the version hasn't changed. To avoid this kind of problems, you should 
delete the old package via ~list-packages~, restart Emacs and then reinstall 
the package.
 
-    This also applies when updating via package and MELPA.
+This also applies when updating via package and MELPA.
 * Features
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
@@ -373,7 +294,7 @@ PDFView Mode is an Emacs PDF viewer. It displays PDF files 
as PNG images in Emac
 | Store position / Jump to position in register | ~m~ / ~'~             |
 |-----------------------------------------------+-----------------------|
 |                                               |                       |
-Note that PDF Tools renders the PDF as images inside Emacs. This means that 
all the keybindings of ~image-mode~ work on individual PDF pages as well.
+Note that ~pdf-tools~ renders the PDF as images inside Emacs. This means that 
all the keybindings of ~image-mode~ work on individual PDF pages as well.
 | Image Mode             |                                             |
 |------------------------+---------------------------------------------|
 | image-scroll-right     | ~C-x >~ / ~<remap> <scroll-right>~          |
@@ -411,7 +332,7 @@ Note that PDF Tools renders the PDF as images inside Emacs. 
This means that all
 :CREATED:  [2021-12-30 Thu 16:58]
 :ID:       5fff6471-a933-46d7-8ae9-b2fa4a9de952
 :END:
-PDF Tools supports working with PDF Annotations. You can display and list text 
and markup annotations (like squiggly, highlight), 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.
+~pdf-tools~ supports working with PDF Annotations. You can display and list 
text and markup annotations (like squiggly, highlight), 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.
 *** Keybindings for working with Annotations
 :PROPERTIES:
 :CREATED:  [2021-12-30 Thu 17:08]
@@ -478,14 +399,14 @@ PDF Tools supports working with PDF Annotations. You can 
display and list text a
   M-x pdf-tools-help RET
 #+end_src
 
-Run ~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:
 :CREATED:  [2021-12-29 Wed 13:51]
 :ID:       8dccd685-18b8-4c98-977a-0fe2d66b724c
 :END:
-Once you have read through the features provided by PDF Tools, you probably 
want to customize the behavior of the features as per your requirements. Full 
customization of features is available by running the following:
+Once you have read through the features provided by ~pdf-tools~, you probably 
want to customize the behavior of the features as per your requirements. Full 
customization of features is available by running the following:
 #+begin_src elisp
   M-x pdf-tools-customize RET
 #+end_src
@@ -501,7 +422,7 @@ Once you have read through the features provided by PDF 
Tools, you probably want
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       73625d02-d472-4e7d-9805-db6d3b60e0ff
 :END:
-PDF Tools does not work well together with ~linum-mode~ and activating it in a 
~pdf-view-mode~, e.g. via ~global-linum-mode~, might make Emacs choke.
+~pdf-tools~ does not work well together with ~linum-mode~ and activating it in 
a ~pdf-view-mode~, e.g. via ~global-linum-mode~, might make Emacs choke.
 
 ** auto-revert
 :PROPERTIES:



reply via email to

[Prev in Thread] Current Thread [Next in Thread]