Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

man page for pdfatfi #3

Closed
kberry opened this issue Nov 24, 2019 · 7 comments
Closed

man page for pdfatfi #3

kberry opened this issue Nov 24, 2019 · 7 comments

Comments

@kberry
Copy link

@kberry kberry commented Nov 24, 2019

Clearly no hurry, but please write a man page for pdfatfi, or add pod doc to pdfatfi.pl so I can turn it into a man page. (If examples would be helpful, we do this pod2man for a few other scripts, such as a2ping and ctan-o-mat.) Thanks.

@davidcarlisle

This comment has been minimized.

Copy link
Member

@davidcarlisle davidcarlisle commented Nov 24, 2019

Ok (I'd be tempted just to delete it, which would be simpler, but if it is there I suppose it should have some documentation)

@kberry

This comment has been minimized.

Copy link
Author

@kberry kberry commented Nov 24, 2019

If you want to delete it, I don't mind. I just discovered that by accident some of the leading comments lacked the # char, i.e., the script has not actually been runnable for some time. I never saw any reports ...

@davidcarlisle

This comment has been minimized.

Copy link
Member

@davidcarlisle davidcarlisle commented Nov 24, 2019

@davidcarlisle

This comment has been minimized.

Copy link
Member

@davidcarlisle davidcarlisle commented Nov 25, 2019

@kberry something like this? I stole some text from the script's --help output and from the attachfile2 documentation.

.TH pdfatfi 1 "2019-11-24"
.SH NAME
pdfatfi \- Help program for the LaTeX package attachfile2.
.SH SYNOPSIS
pdfatfi <command> [<options>] <file[.atfi]>]
.SH DESCRIPTION
Help program for the LaTeX package attachfile2.

This package also tries to get and add meta information data,
such as file size, file date, checksum, ....

The script pdfatfi.pl is provided for use with old versions of
pdfTeX and XeTeX that do not provide access
to  file metadata.

The use of the Perl script is not mandatory. This data can be shown
by PDF viewers, but they are not a requirement of the PDF specification.

Package attachfile2 and the Perl script communicate
via an auxiliary file with file extension .atfi. The script
is used between two LaTeX runs and updates the auxiliary file.

.nf
latex test
pdfatfi test
latex test
dvips test
ps2pdf test.ps test.pdf
.fi

.SH OPTIONS
Various options apply 
.IP --help   
Show help text.
.IP --version
Print version number
.IP --(no)quiet
Suppress/don't suppress messages
.IP --(no)verbose
Verbose (not verbose) printing.
.IP --(no)debug
Debug infomation printed (not printed)
.SH BUGS
.SH AUTHOR
Heiko Oberdiek (ho-tex@tug.org)
.PP
Please log issues on the GitHub homepage:
.br
https://github.com/ho-tex/attachfile2/issues.
.SH SEE ALSO
See attachfile2.pdf for more details.

If that looks plausible I'll add it to attachfile2.dtx to be extracted as pdfatfi.1

@kberry

This comment has been minimized.

Copy link
Author

@kberry kberry commented Nov 25, 2019

@davidcarlisle

This comment has been minimized.

Copy link
Member

@davidcarlisle davidcarlisle commented Nov 25, 2019

OK I'll package it as:

.TH pdfatfi 1 "2019-11-24"
.SH NAME
pdfatfi \- Help program for the LaTeX package attachfile2.
.SH SYNOPSIS
pdfatfi <command> [<options>] <file[.atfi]>]
.SH DESCRIPTION
Helper program for the LaTeX package attachfile2.

This package also tries to get and add meta information data,
such as file size, file date, checksum, ....

The script pdfatfi.pl is provided for use with old versions of
pdfTeX and XeTeX that do not provide access
to  file metadata.

The use of the Perl script is not mandatory. This data can be shown
by PDF viewers, but they are not a requirement of the PDF specification.

Package attachfile2 and the Perl script communicate
via an auxiliary file with file extension .atfi. The script
is used between two LaTeX runs and updates the auxiliary file.

.nf
latex test
pdfatfi test
latex test
dvips test
ps2pdf test.ps test.pdf
.fi

.SH OPTIONS
Various options are supported
.IP --help   
Show help text.
.IP --version
Print version number
.IP --(no)quiet
Suppress/don't suppress messages
.IP --(no)verbose
Verbose (not verbose) printing.
.IP --(no)debug
Debug infomation printed (not printed)
.SH BUGS
Please log issues on the GitHub homepage:
.br
https://github.com/ho-tex/attachfile2/issues.
.SH AUTHOR
Heiko Oberdiek (ho-tex@tug.org)
.SH SEE ALSO
See attachfile2.pdf for more details.
@davidcarlisle

This comment has been minimized.

Copy link
Member

@davidcarlisle davidcarlisle commented Nov 26, 2019

pushed to ctan

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.