Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/md/Corrupted-installation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Corrupted installation

If you're reading this, you might have been told by SumatraPDF that you have a corrupted installation.
If you're reading this, you might have been told by PrettySumatraPDF that you have a corrupted installation.

**How can that happen?**

SumatraPDF comes in two flavors: a portable version and an installer.
PrettySumatraPDF comes in two flavors: a portable version and an installer.

A portable version is a self-contained executable and cannot be corrupted.

Expand All @@ -13,11 +13,11 @@ An installer needs to be run to be properly installed. Part of it is extracting
There are 2 possible problems:

- `libmupdf.dll` is missing
- `libmupdf.dll` is there but its version doesn't match the version of `SumatraPDF.exe`
-- `libmupdf.dll` is there but its version doesn't match the version of `PrettySumatraPDF.exe`

**How to solve the problem?**

If you want to place SumatraPDF in any location, under any name, use the self-contained portable flavor.
If you want to place PrettySumatraPDF in any location, under any name, use the self-contained portable flavor.

If you insist on using the installable version, just install it. The installer will run if it has `-install` in the name of the `.exe` (which it will if you download [official build](https://www.sumatrapdfreader.org/download-free-pdf-viewer)).

Expand Down
2 changes: 1 addition & 1 deletion docs/md/DDE-Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Multiple DDE commands: `[Command1(parameter1, parameter2, ..., )][Command2(...)]

You can either use windows api by sending DDE commands to server `SUMATRA` and topic `control`. See [this code](https://github.com/sumatrapdfreader/sumatrapdf/blob/master/src/utils/WinUtil.cpp#L2437) for example of sending DDE command.

Or you can use `-dde` command-line argument to `SumatraPDF.exe` e.g. `SumatraPDF.exe -dde "[SetView(\"c:\\file.pdf\",\"continuous\",-3)]"`.
Or you can use `-dde` command-line argument to `PrettySumatraPDF.exe` e.g. `PrettySumatraPDF.exe -dde "[SetView(\"c:\\file.pdf\",\"continuous\",-3)]"`.

Notice escaping of DDE command string: `"` and `\` with `\`.

Expand Down
14 changes: 7 additions & 7 deletions docs/md/Debugging-Sumatra.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Debugging Sumatra
# Debugging PrettySumatraPDF

**Help us debug Sumatra hangs or crashes**

If Sumatra crashes or hangs reliably on your machine but we can't reproduce it ourselves, you can help us by debugging it. Here's a tutorial on how to do it.
If PrettySumatraPDF crashes or hangs reliably on your machine but we can't reproduce it ourselves, you can help us by debugging it. Here's a tutorial on how to do it.

Please first test with latest pre-release version from [https://www.sumatrapdfreader.org/prerelease.html](https://www.sumatrapdfreader.org/prerelease.html)

Expand All @@ -21,17 +21,17 @@ This saves logs to a file and opens default editor for `.txt` files with log fil
## Install necessary software

- Install WinDBG debugger from Microsoft Store at [https://www.microsoft.com/en-us/p/windbg-preview/9pgjgd53tn86#activetab=pivot:overviewtab](https://www.microsoft.com/en-us/p/windbg-preview/9pgjgd53tn86#activetab=pivot:overviewtab). Alternatively, you can follow instructions from [https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/debugger-download-tools](https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/debugger-download-tools)
- In SumatraPDF, use menu `Debug` / `Download symbols`. Symbols are important for the debugger (like WinDBG) to resolve addresses to names that
- In PrettySumatraPDF, use menu `Debug` / `Download symbols`. Symbols are important for the debugger (like WinDBG) to resolve addresses to names that

First, vocabulary. `%ProgramFiles%` means the standard directory where Windows installs programs. It's `c:\Program Files` on 32-bit Windows and `c:\Program Files (x86)` on 64-bit Windows.

## Debugging a crash

To debug crashes:

- start SumatraPDF.exe under the control of WinDBG
- start PrettySumatraPDF.exe under the control of WinDBG
- start WinDBG.exe
- File/Open (Ctrl-E), find and open SumatraPDF.exe executable
- File/Open (Ctrl-E), find and open PrettySumatraPDF.exe executable
- In WinDBG, type:
- `.sympath+ SRV*c:\symbols*https://msdl.microsoft.com/download/symbols`
- `g`
Expand All @@ -41,9 +41,9 @@ To debug crashes:

Here are the steps to follow if Sumatra hangs

1. Start SumatraPDF.exe and get it to hang
1. Start PrettySumatraPDF.exe and get it to hang
2. start WinDBG.exe
3. use File/Attach to process (F6) and select SumatraPDF.exe from the
3. use File/Attach to process (F6) and select PrettySumatraPDF.exe from the
4. In WinDBG, type:
- `.sympath+ SRV*c:\symbols*https://msdl.microsoft.com/download/symbols`
- `~*kb`
Expand Down
4 changes: 2 additions & 2 deletions docs/md/Failed-to-load-libmupdf.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Failed to load libmupdf.dll

When installed, SumatraPDF consists of 2 files:
* `SumatraPDF.exe`
When installed, PrettySumatraPDF consists of 2 files:
* `PrettySumatraPDF.exe`
* `libmupdf.dll`

You're reading this page because loading of `libmupdf.dll` failed and we can't proceed.
Expand Down
14 changes: 7 additions & 7 deletions docs/md/LaTeX-integration.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# LaTeX integration

You can use [DDE commands](DDE-Commands.md) from TeX and LaTeX editors to use Sumatra as a previewer.
You can use [DDE commands](DDE-Commands.md) from TeX and LaTeX editors to use PrettySumatraPDF as a previewer.

## notepad++

Launch SumatraPDF from notepad++ enabling forward and backward search:

```
"C:\Program files\SumatraPDF\SumatraPDF.exe" -forward-search "$(FULL_CURRENT_PATH)" $(CURRENT_LINE) -inverse-search "\"C:/Program Files/Notepad++/notepad++.exe\" \"%f\" -n%l" "$(CURRENT_DIRECTORY)"/"$(NAME_PART)".pdf
"C:\Program files\PrettySumatraPDF\PrettySumatraPDF.exe" -forward-search "$(FULL_CURRENT_PATH)" $(CURRENT_LINE) -inverse-search "\"C:/Program Files/Notepad++/notepad++.exe\" \"%f\" -n%l" "$(CURRENT_DIRECTORY)"/"$(NAME_PART)".pdf
```

## TexStudio

Launch SumatraPDF from TeXStudio enabling forward and backward search:

```
"C:/Program Files/SumatraPDF/SumatraPDF.exe" -forward-search "?c:am.tex" @ -inverse-search "\"C:/Program Files (x86)/TeXstudio/texstudio.exe\" \"%%f\" -line %%l" "?am.pdf"
"C:/Program Files/PrettySumatraPDF/PrettySumatraPDF.exe" -forward-search "?c:am.tex" @ -inverse-search "\"C:/Program Files (x86)/TeXstudio/texstudio.exe\" \"%%f\" -line %%l" "?am.pdf"
```

## TeXnicCenter
Expand All @@ -29,7 +29,7 @@ Configure viewer in [output profiles](https://texniccenter.sourceforge.net/confi
- press `Alt + F7` (`Build` > `Define Output Profiles`)
- for any one of the PDF Profiles e.g. `LaTeX` > `PDF`
- for Executable path it should have something like:
- `C:\Program Files\SumatraPDF\SumatraPDF.exe -inverse-search "\"C:\Program Files (x86)\TeXnicCenter\TeXnicCenter.exe\" /ddecmd \"[goto('%f','%l')]\""`
- `C:\Program Files\PrettySumatraPDF\PrettySumatraPDF.exe -inverse-search "\"C:\Program Files (x86)\TeXnicCenter\TeXnicCenter.exe\" /ddecmd \"[goto('%f','%l')]\""`
- `SumatraPDF.exe` path might be different on your computer
- go back to the editor and using any simple .TeX press `Ctrl + Shift + F5` (Build and view)
- SumatraPDF should have fired up with the compiled PDF
Expand Down Expand Up @@ -76,12 +76,12 @@ language):
```
def ForwardSearch()
var filename_root = expand('%:p:r')
system($'SumatraPDF.exe -forward-search {filename_root}.tex {line(".")} {filename_root}.pdf')
system($'PrettySumatraPDF.exe -forward-search {filename_root}.tex {line(".")} {filename_root}.pdf')
enddef
```

Replace `SumatraPDF.exe` with the correct executable filename,
e.g. `SumatraPDFv3-4-5.exe`.
e.g. `PrettySumatraPDF.exe`.

Next, you should map this function to some key, for example you could use the
following.
Expand All @@ -104,7 +104,7 @@ def g:BackwardSearch(line: number, filename: string)
enddef
```

Next, open `SumatraPDF` and go to _Settings/Options_. Replace the line in the
Next, open `PrettySumatraPDF` and go to _Settings/Options_. Replace the line in the
_Set inverse-search command-line_ box, with the following:

```
Expand Down
12 changes: 6 additions & 6 deletions docs/md/Uninstalling-SumatraPDF.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Uninstalling SumatraPDF
# Uninstalling PrettySumatraPDF

## Are you using official Sumatra build?

Did you download Sumatra from [official Sumatra website](https://www.sumatrapdfreader.org/download-free-pdf-viewer)?

If not, we can't help you because we didn't create the software you're using.

## Uninstalling Sumatra
## Uninstalling PrettySumatraPDF

There are 2 versions of Sumatra: an installer and a portable version (zipped executable).
There are 2 versions of the program: an installer and a portable version (zipped executable).

## Uninstalling portable version

If you're using zipped executable, the only thing you need to do is to delete SumatraPDF.exe.
If you're using zipped executable, the only thing you need to do is to delete PrettySumatraPDF.exe.

## Uninstalling the installer version

If you installed SumatraPDF by running official installer, you uninstall it like every other application.
If you installed PrettySumatraPDF by running an installer, you uninstall it like every other application.

On Windows 10 / 11:

- start Settings app ([https://www.digitalcitizen.life/introducing-windows-10-ways-open-settings](https://www.digitalcitizen.life/introducing-windows-10-ways-open-settings))
- Select `Apps`
- find `SumatraPDF` on the list, click it and press `Uninstall` button:
- find `PrettySumatraPDF` on the list, click it and press `Uninstall` button:

![Uninstall](img/uninstall.png)

Expand Down
58 changes: 29 additions & 29 deletions RELEASE_DRAFT.md → docs/releases/RELEASE_DRAFT.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# PrettySumatraPDF v1.0.0 — Release Draft
Release date: 2026-05-09
## Summary
PrettySumatraPDF v1.0.0 is the first official release of the PrettySumatra redesign. It preserves the full functionality of the original SumatraPDF reader while introducing a modern native UI and optional hybrid WebView2 components.
## Highlights
- Modern native Win32 toolbar and visual refresh
- All original formats supported (PDF, EPUB, MOBI, CBZ, CBR, FB2, CHM, XPS, DjVu)
- Preserved command behavior, shortcuts, and features
- Improved toolbar density and Windows 11–inspired visuals
- Hybrid WebView2 integration for advanced UI components
## Download
(Attach installer and archive artifacts here.)
## Notes
See `RELEASE_NOTES_v1.0.0.md` for full details.
---
### How to produce the installer (developer)
See `scripts/installer/README_INSTALLER.md` for build instructions.
# PrettySumatraPDF v1.0.1 — Release Draft

Release date: 2026-05-30

## Summary

PrettySumatraPDF v1.0.1 is the first official release of the PrettySumatra redesign. It preserves the full functionality of the original SumatraPDF reader while introducing a modern native UI and optional hybrid WebView2 components.

## Highlights

- Modern native Win32 toolbar and visual refresh
- All original formats supported (PDF, EPUB, MOBI, CBZ, CBR, FB2, CHM, XPS, DjVu)
- Preserved command behavior, shortcuts, and features
- Improved toolbar density and Windows 11–inspired visuals
- Hybrid WebView2 integration for advanced UI components

## Download

(Attach installer and archive artifacts here.)

## Notes

See [RELEASE_NOTES_v1.0.1.md](RELEASE_NOTES_v1.0.1.md) for full details.

---

### How to produce the installer (developer)

See [../installer/README_INSTALLER.md](../installer/README_INSTALLER.md) for build instructions.
44 changes: 22 additions & 22 deletions RELEASE_NOTES_v1.0.0.md → docs/releases/RELEASE_NOTES_v1.0.0.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# PrettySumatraPDF — v1.0.0 (First Release)
Release date: 2026-05-09
## Overview
PrettySumatraPDF is the first release of the PrettySumatra redesign. It preserves the full functionality of the original SumatraPDF reader while providing a modernized native UI and optional hybrid WebView2 features.
## Highlights
- Modern native Win32 toolbar and visual refresh
- All original formats supported (PDF, EPUB, MOBI, CBZ, CBR, FB2, CHM, XPS, DjVu)
- Preserved command behavior, shortcuts, and features
- Improved toolbar density and Windows 11–inspired visuals
- Hybrid WebView2 integration for advanced UI components
## Screenshots
- Toolbar: `docs/md/img/toolbar.png`
- Command palette: `docs/md/img/command-palette-tabs.png`
- Annotation editor: `docs/md/img/annotation-editor.png`
- Settings: `docs/md/img/settings-app.png`
# PrettySumatraPDF — v1.0.0 (First Release)

Release date: 2026-05-09

## Overview

PrettySumatraPDF is the first release of the PrettySumatra redesign. It preserves the full functionality of the original SumatraPDF reader while providing a modernized native UI and optional hybrid WebView2 features.

## Highlights

- Modern native Win32 toolbar and visual refresh
- All original formats supported (PDF, EPUB, MOBI, CBZ, CBR, FB2, CHM, XPS, DjVu)
- Preserved command behavior, shortcuts, and features
- Improved toolbar density and Windows 11–inspired visuals
- Hybrid WebView2 integration for advanced UI components

## Screenshots

- Toolbar: [../md/img/toolbar.png](../md/img/toolbar.png)
- Command palette: [../md/img/command-palette-tabs.png](../md/img/command-palette-tabs.png)
- Annotation editor: [../md/img/annotation-editor.png](../md/img/annotation-editor.png)
- Settings: [../md/img/settings-app.png](../md/img/settings-app.png)
22 changes: 22 additions & 0 deletions docs/releases/RELEASE_NOTES_v1.0.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# PrettySumatraPDF — v1.0.1 (First Release)

Release date: 2026-05-30

## Overview

PrettySumatraPDF is the first release of the PrettySumatra redesign. It preserves the full functionality of the original SumatraPDF reader while providing a modernized native UI and optional hybrid WebView2 features.

## Highlights

- Modern native Win32 toolbar and visual refresh
- All original formats supported (PDF, EPUB, MOBI, CBZ, CBR, FB2, CHM, XPS, DjVu)
- Preserved command behavior, shortcuts, and features
- Improved toolbar density and Windows 11–inspired visuals
- Hybrid WebView2 integration for advanced UI components

## Screenshots

- Toolbar: [../md/img/toolbar.png](../md/img/toolbar.png)
- Command palette: [../md/img/command-palette-tabs.png](../md/img/command-palette-tabs.png)
- Annotation editor: [../md/img/annotation-editor.png](../md/img/annotation-editor.png)
- Settings: [../md/img/settings-app.png](../md/img/settings-app.png)
Loading
Loading