Skip to content

Commit

Permalink
0.2: Added man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
zvezdochiot committed Apr 5, 2020
1 parent bb99f7d commit 21a4d49
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
30 changes: 30 additions & 0 deletions man/man1/patchmatch.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.TH "PatchMatch" 1 "05 Apr 2020" 0.2 " User Manual"

.SH NAME
patchmatch

.SH SYNOPSIS
\fBpatchmatch\fR \fI[image_path] [mask_path] [output_path] [log_path] [misc]\fR
\fBpatchmatch\fR \fI[image] [mask] [output]\fR

.SH DESCRIPTION
PatchMatch for inpainting using OpenCV 3.x

.SH EXAMPLE
.TP
log mode:
\fIfor i in $(seq 0 2); do \fBpatchmatch\fI image_files/inpainting/image/image_0000$i.png image_files/inpainting/mask/mask_0000$i.png image_files/inpainting/output/output_0000$i.png image_files/inpainting/metrics.log $i; done\fR
.TP
simple:
\fBpatchmatch\fI image_files/forest/forest.bmp image_files/forest/forest_mask.png image_files/forest/forest_inpaint.png\fR

.SH COPYRIGHT
Public Domain Mark 1.0
No Copyright

.SH SEE ALSO
convert(1),
inpaint(1)

.SH CONTACTS
Homepage: https://github.com/ZQPei/patchmatch_inpainting
2 changes: 1 addition & 1 deletion run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ cd ..


# run and test on some local cases
for i in 0 1 2; do
for i in $(seq 0 2); do
./build/patchmatch image_files/inpainting/image/image_0000$i.png \
image_files/inpainting/mask/mask_0000$i.png \
image_files/inpainting/output/output_0000$i.png \
Expand Down

1 comment on commit 21a4d49

@zvezdochiot
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added simple manual pages and enumeration replaced by seq.

Please sign in to comment.