Skip to content

Commit 48c1910

Browse files
moormasterLucas-C
authored andcommitted
DOC: add documentation for extract-annotated-pages subcommand
Issue: #95
1 parent e3845da commit 48c1910

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ pdfly is a command line tool to get information about PDF documents and to manip
1616
user/subcommand-meta
1717
user/subcommand-cat
1818
user/subcommand-x2pdf
19+
user/subcommand-extract-annotated-pages
1920
user/subcommand-extract-images
2021
user/subcommand-2-up
2122
user/subcommand-booklet
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# extract-annotated-pages
2+
3+
Extract only the annotated pages from a PDF. This can help to review or rework pages from a large document iteratively.
4+
5+
## Usage
6+
7+
```
8+
pdfly extract-annotated-pages --help
9+
10+
Usage: pdfly extract-annotated-pages [OPTIONS] INPUT_PDF
11+
12+
Extract only the annotated pages from a PDF.
13+
14+
Q: Why does this help?
15+
A: https://github.com/py-pdf/pdfly/issues/97
16+
17+
╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
18+
│ * input_pdf FILE Input PDF file. [required] │
19+
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
20+
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
21+
│ --output -o PATH Output PDF file. Defaults to 'input_pdf_annotated'. │
22+
│ --help Show this message and exit. │
23+
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
24+
25+
```
26+
27+
## Examples
28+
29+
### Input file
30+
31+
Extracts only pages containing annotations from a file `input.pdf`. Pages are written into a new file `input_annotated.pdf`.
32+
33+
```
34+
pdfly extract-annotated-pages input.pdf
35+
```
36+
37+
### Input file with specific output file
38+
39+
Extracts only pages containing annotations from a file `input.pdf` into the given output file `pages_to_rework.pdf`.
40+
41+
42+
```
43+
pdfly extract-annotated-pages input.pdf -o pages_to_rework.pdf
44+
```

0 commit comments

Comments
 (0)