BeCyPDFMetaEdit Help

Contents

1. User Interface

1.1 General

1.2 Metadata

1.3 Metadata (XMP)

1.4 Viewer Preferences

1.5 Pages

1.6 Bookmarks

1.7 Slide Show

1.8 Security

1.9 Extras

2. Command Line

2.1 Synopsis

2.2 Exitcode / Output

2.3 Dynamic Path Names

2.4 Summary Templates

2.5 Examples

1. User Interface

1.1 General

The PDF document to be edited is selected at "Source". To do so, the

button "Open..." allows browsing the file system. After opening a file,

the application will read its content and display the available data in

the various fields and tabs for editing.

When opening a document, one can choose among three editing modes:

incremental updating, complete rewriting and repairing.

Using incremental updating, the changes are just appended to the end of

the original file without touching its previous contents, i. e. the

appended changes will logically overwrite the old data rather than

physically. This method allows fast opening and updating even of huge

documents and allows furthermore to undo the changes and to restore the

original document contents. Two disadvantages of this approach should

also be mentioned. First, repeated updating of a document will increase

its file size. Second, the optimization for fast web-view

(linearization) becomes unusuable.

Using complete rewriting, the file is entirely regenerated and its

previous content is overwritten with the updated document. All

previously made incremental updates will be irreversibly merged into a

single new edition of the document. Rewriting a file requires more

memory and time both when loading and saving a document. The advantage

of this approach is the possibility to change the document's encryption

or to reduce the file size by merging incremental updates.

The mode repair is basically the same as rewriting. The only difference

is that upon loading the document syntax errors are ignored or corrected

if possible. This mode should only be chosen if the application reports

errors that indicate a file corruption when loading the document.

Note: The application does not support signed documents. Saving such

documents may therefore invalidate the integrity of the document.

Documents can be opened directly from the Windows Explorer using

Drag&Drop, too. One simply clicks the document with the left mouse

button and drags it onto the main window of the application. The actual

editing mode for the document is controlled by the keyboard:

If the key <Shift> is hold down when releasing the mouse button, the

document is opened for "complete rewriting".

If otherwise the key <Alt> is hold down, the document will be opened

using "repair" mode.

In all other cases, the document will be opened for "incremental

updating".

The buttons "Save" and "Save as..." can be used to write changes to the

current or a new file. For read-only files, the changes can only be

saved to a new file using "Save as...". The kind of saving performed

(complete or incremental) depends on the editing mode selected during

opening.

The button "Cancel" exits the applications. All unsaved changes to the

document are discarded.

1.2 Metadata

This tab allows to edit the general information about the document like

author, title, subject etc.

If the option "Automatic" for the field "Created at" or "Modified at" is

active, the creation/modification date will be set to the current time

when the document is saved.

The timestamps for the file will be automatically synchronized to the

values of the fields "Created at" and "Modified at".

Changing these values can also be performed in batch mode using the

command-line. More information on this topic is available in the section

covering the command-line usage.

1.3 Metadata (XMP)

Since PDF version 1.4, metadata can be stored in a new XML-based format

named XMP ("Extensible Metadata Platform"). With regard to backward

compatibility, newer PDF documents contain the metadata both in XMP and

also in classical form. However, the application is currently not

capable of processing metadata in XMP format. This can lead to the

effect that a PDF viewer shows the original field values after the

metadata has been edited. Even if the PDF viewer shows the new metadata,

the XMP metadata still contains the original field values which could be

extracted using a hex or text editor.

To address these problems, the application allows at least to remove the

XMP metadata. The metadata will then only be stored in the classical

format.

Attention: XMP-based metadata cannot only be specified for the entire

PDF document but also for parts of it. The application only deletes the

document-specific metadata, metadata attached to other document content

stays as is. Therefore, additional tools like a hex editor are required

if all XMP metadata shall be removed.

1.4 Viewer Preferences

Here, certain details about the display of the document by a PDF viewer

can be customized. For instance, the viewer can be told to directly

enter fullscreen mode when opening the document or to show the bookmark

hierarchy.

1.5 Pages

This section allows configuring the page labels for the document. Page

labels primarily specify a numbering style like arabic or roman with an

optional prefix. Some portions of the document like the index, the

appendix or the contents can be equipped with an individual page

numbering that helps the user to orientate himself within the document.

The actual way of page numbering is specified for a continous range of

pages. Such a range begins at an explicitly given page index and extends

to the beginning of the next range with a different numbering.

1.6 Bookmarks

As some kind of hyperlink-like index, the bookmarks of a document allow

a reader to quickly access certain text locations.

After opening a document, the application displays the current bookmark

hierarchy which can then be customized.

The text location to which a bookmark refers is given by a page number

and a position somewhere on this page. The position allows a PDF viewer

to scroll the appropriate text portion into view, regardless of the

current zoom mode. For this reason, the upper-left corner of the text

portion can be specified using the two coordinates X and Y. These

coordinates are relative to a coordinate space whose origin is the

upper-left corner of the current page and whose positive x-/y-axis point

rightwards/downwards. The length of a unit is one Millimeter (1 in =

25,4 mm) on both axes. For instance, the tuple (X=0 / Y=0) refers to the

beginning of the page while (X = 210 / Y = 297) refers to the lower-

right edge of a DIN A4 page.

Note: Bookmarks whose text location is unknown are indicated by the page

number ? (zoom mode and scroll position are also unknown in this case).

The other attributes of such bookmarks can be edited without affecting

the function of the bookmark. Explicitly adjusting the page number is

not neccessary:

1.7 Slide Show

The elements of this tab allow to edit the page transitions for a slide

show presentation of the document. PDF viewer will typically use those

transition effects only when viewing the document in full-screen mode.

The "display duration" of a page denotes the maximum time before a PDF

viewer automatically advances to the next page. The value 0 indicates

that no automatic page navigation is to be performed.

The field "Effect" controls the style of the transition to this page and

"Effect duration" gives the speed of the transition. Depending on the

effect selected, several other options can be used to further customize

the transition.

1.8 Security

Note: The elements of this page are only enabled when the document was

opened for "complete rewrite".

The selection box "Security system" determines the encryption of the

document. The current encryption can be left unchanged, it can be

entirely removed or replaced with a new password-based one.

When choosing a password-based encryption, additional fields allow

setting two passwords and optionally to restrict permissions. An

encrypted document can be fully opend with either of the two passwords

(owner/user). Differences only arise when concerning further operations

like printing or modifying the document. For a document with different

owner and user passwords, persons giving the correct owner password will

always have unrestricted access to the document. In contrast, persons

giving just the user password can only perform operations granted by the

permissions.

Note that PDF viewer will only prompt for a password when the user

password is set for a document. In other words, a document without an

user password but with an owner password can be opened by anyone who is

then automatically subject to the access restrictions set.

The granularity of the permissions depends on the selected security

system. But in general, a permission with a check mark is granted to the

user. In order to deny a certain operation, the corresponding check mark

has to be removed.

1.9 Extras

Some technical details about the document's file structure and command

for special tasks can be found on this page.

The "PDF version" indirectly indicates which features of the PDF

specification a document uses and which PDF viewer is required to fully

support all those features.

If the document was not opened for incremental update, the PDF version

can be altered, too. This feature might be useful for preventing an

annoying warning message displayed by old PDF viewers when opening a PDF

document with a rather new version.

Note: Changing the PDF version only affects the header of the PDF file.

The body of the document is neither checked for conformance with the new

version nor is the body converted.

The "Document edition" illustrates how often the document has been

updated using incremental updates. The application titles the original

version of a document as "1. edition", a document with one update as "2.

edition" and so on.

The "File identifier" serves the unique identification of the document,

e. g. for external links or in workflows. It usually consists of two

hexadecimal-encoded byte sequences (major and minor id) each being 16

bytes long. The major id should not change when updating the document.

If the option "Automatic" is active, the application will create a new

minor id for the document upon saving in order to separate the new

document edition from its previous edition.

The buttons "Save template..." and "Open template..." support loading

and saving of all the document settings from/into a text file for easier

reusage. This way, metadata, viewer preferences, bookmarks etc. can be

configured once for later or multiple usage.

The dialogs for saving/opening templates allow to restrict which

settings to export/import. Importing settings overwrites the current

document contents, therefore not importing settings simply means to keep

the current setting.

Tip: Users requiring an even finer control over the settings to be

imported are encouraged to directly edit the template file using an

ordinary text editor. This way, individual settings can be deleted from

the sections (by deleting the whole line not just the value) which are

not to be imported.

Using the button "Restore edition..." previously saved incremental

updated can be undone in order to restore some older document edition.

The requested document edition is stored to a new file so that its

contents can be verified.

2. Command Line

2.1 Synopsis

Most of the application functionality can be used by script or batch

files using the command-line, i. e. without interaction with a user. The

exact format of the command-line to issue is described below. The long-

options have not been listed here in favor of a compact presentation.

Brackets [ ] indicate optional parameters.

> BeCyPDFMetaEdit ["PDF file"]

[-s [RecursionDepth]]

[-d EditingMode]

[-V PdfVersion]

[-T "Title"]

[-S "Subject"]

[-A "Author"]

[-K "Keywords"]

[-R "Application"]

[-P "Generator"]

[-C "Created"]

[-M "Modified"]

[-X DeleteMode]

[-PL PageLayout]

[-PM PageMode]

[-Pm PageModeAfterFullScreen]

[-HT Mode]

[-HM Mode]

[-HW Mode]

[-CW Mode]

[-FW Mode]

[-DDT Mode]

[-FP FirstPage]

[-pl "PageLabel"] ... [-pl "PageLabel"]

[-pwd "Password"]

[-e Encryption]

[-o "Owner"]

[-u "User"]

[-p "Permissions"]

[-tf "TemplateFile"]

[-tm "TemplateMask"]

[-st "SummaryTemplate"]

[-sf "SummaryTemplateFile"]

[-so "SummaryOutput"]

[-r] [-f] [-q] [-v] [-?]

The meaning of the individual parameters and flags is as follows:

"PDF file"

path to the PDF document to edit. The usual wildcard characters asterisk

(*) and question mark (?) can be used to specify a search pattern and to

process all documents within a directory whose file names match the

pattern; omitting PDF file directs the application to start the

interactive mode (as long as the flags -? or -v are not given)

-s, -SubDirs RecursionDepth

maximum recursion depth when scanning sub directories for documents

which match the pattern; a value of 0 for RecursionDepth limits the

search to the base directory, a value of 1 includes also all immediate

sub directories of the base directory and so on

If this parameter is entirely omitted, there will be no recursion at

all. If the parameter is used just without a value for RecursionDepth,

all reachable sub directories are scanned.

-d, -EditMode EditingMode

mode to use when opening the document (see subsection 1.1); allowed

values for EditingMode are:

1 incremental updating

2 complete rewriting

3 repairing

If this parameter is omitted, the application behaves as follows:

Giving -Repair selects EditingMode 3, giving any parameter concerning

the encryption selects EditingMode 2, otherwise the default EditingMode

1 is chosen.

-V, -PdfVersion PdfVersion

new PDF version of the document (see subsection 1.9); valid values are

strings of the form "major.minor" like "1.0", "1.1", ... and "1.6".

Note: The PDF version can only be lowered using this option (downgrade

of version).

-T, -Title "Title"

new title for the document

-S, -Subject "Subject"

new subject for the document

-A, -Author "Author"

new author for the document

-K, -Keywords "Keywords"

new keywords for the document

-R, -Creator "Application"

new name for the application that created the original text document

-P, -Producer "Generator"

new name for the application that produced the PDF document (from the text document)

-C, -Created "Created"

new creation date for the document (format according to PDF

specification, D:YYYYMMDDHHMM); alternatively, the special value auto

can be specified to use the current time; the timestamp of the file will

be synchronized to this value

-M, -Modified "Modified"

new modification date for the document (format according to PDF

specification, D:YYYYMMDDHHMM); alternatively, the special value auto

can be specified to use the current time; the timestamp of the file will

be synchronized to this value

-X, -DeleteXMP DeleteMode

allows to remove the XMP metadata of the document; possible values are:

0 keep XMP metadata (default)

1 remove XMP metadata

-PL, -PageLayout PageLayout

new page layout; allowed values for PageLayout are:

0 default

1 single page

2 continous

3 two pages (1st page left)

4 two pages (1st page right)

-PM, -PageMode PageMode

new page mode; allowed values for PageMode are:

0 default

1 simple

2 bookmarks

3 thumbnails

4 fullscreen

5 content group

6 attachments

-Pm, -PageModeNFS PageModeAfterFullScreen

new page mode after leaving the page mode fullscreen; allowed values for

PageModeAfterFullScreen are:

0 default

1 simple

2 bookmarks

3 thumbnails

5 content group

-HT, -HideToolbar Mode

new display mode for the toolbar; allowed values for Mode are:

0 show

1 hide

-HM, -HideMenubar Mode

new display mode for the menubar; allowed values for Mode are:

0 show

1 hide

-HW, -HideWindowUI Mode

new display mode for the window user interface (scroll bars, navigation

controls); allowed values for Mode are:

0 show

1 hide

-CW, -CenterWindow Mode

new display mode for the document window; allowed values for Mode are:

0 no centering

1 center window on screen

-FW, -FitWindow Mode

new size mode for the document window; allowed values for Mode are:

0 no resizing

1 resize window to fit first page of document

-DDT, -DisplayDocTitle Mode

new display mode for the window title; allowed values for Mode are:

0 show file name

1 show document title (as given by the metadata)

-FP, -FirstPage FirstPage

new first page to display; the value FirstPage gives the one-based index

of the page that a PDF viewer is supposed to show first when opening a

document

-pl, -PageLabel "PageLabel"

creates a page label for a continous range of pages; the value PageLabel

gives the details for the page numbering and has the following format:

FirstPage Style [Offset [Prefix]] where the individual components are

encoded as follows:

FirstPage

one-based index of the page from which on the page label is to be applied

Style

single character specifying the numbering style; supported values are:

_

no numbering

D

arabic decimal numbers (1, 2, 3, 4, ...)

R

roman numbers using uppercase letters (I, II, III, IV, ...)

r

roman numbers using lowercase letters (i, ii, iii, iv, ...)

A

alphabetic uppercase letters (A, B, C, D, ...)

a

alphabetic lowercase letters (a, b, c, d, ...)

Offset

number from which on to start the page numbering within the page range

(default: 1)

Prefix

text to be prepended to the page numbers

Note that the components of PageLabel are self-delimitting and hence are

to be concatenated without any delimitter (the spaces in the above

notation are just for optical separation and are not part of the

format).

A complete page label specification for the whole document will

typically consist of multiple such page ranges so that for each range

one parameter -pl "PageLabel" is to be given. The order of the several

parameters does not matter. The only requirement is that there be a

parameter specifying a page label starting at page index 1 so that each

page of the document is properly numbered.

The parameter given on its own without any values will delete all page

labels from the document.

-pwd, -Password "Password"

allows opening password-protected documents; documents with different

owner and user passwords will often require the owner password in order

to be modified

-e, -Encrypt Encryption

new encryption method for document; valid values for Encryption are:

0 keep current settings

1 no encryption

2 password protection with low encryption (Acrobat 3.x or higher)

3 password protection with high encryption (Acrobat 5.x or higher)

The application behaves as follows when omitting this parameter: If

passwords are given by the parameters -PwdOwner or -PwdUser, the value 3

is assumed for Encryption. Otherwise it defaults to value 0.

-o, -PwdOwner "Besitzer"

new owner password for unrestricted acces to document contents; this

parameter is meaningless if Encryption is not set to value 2 or 3.

-u, -PwdUser "Benutzer"

new user password for possibly restricted acces to document contents;

this parameter is meaningless if Encryption is not set to value 2 or 3.

-p, -Permit "Permissions"

bit mask giving which operations users may perform in addition to just

open the document; these bits are represented by a single character in

Permissions with an occurence of the character being interpreted as 1 (=

grant permission) and its absence as 0 (= deny permission):

p Print

P Print using full resolution (addition to bit p; only valid for

Encryption 3 or higher); not setting this bit in addition to bit p

will restrict printing using a low resoluation

m Change the document

A Assemble the document (only valid for Encryption 3 or higher);

if bit m is not set, this permission still allows restricted

modificatios to the document (e. g. insert/delete/rotate pages)

x Extract/copy contents from the document (e. g. using the clipboard)

X Extract contents in support of accessibility (only valid for

Encryption 3 or higher); if bit x is not set, this permissions

still allows for accessibility

a Add comments and fill-in form fields

F Fill-in form fields (only valid for Encryption 3 or higher);

if bitit a is not set, this permission still allows filling-in

form fields

Note that this mask is case-sensitive. Omitting this parameter entirely

results in setting all permissions. When giving this parameter (which

includes just giving its name) only those permissions explicitly given

are set.

Changing permissions is only possible in conjunction with the parameters

-PwdOwner and -PwdUser.

-tf, -Template "TemplateFile"

path to a template from which the settings for the document update will

be read; competing values from the command-line have precedence over

values from the template; which values from the template are to be

processed can be controlled via the -TemplateMask parameter

Giving just ">" for TemplateFile (whereas the quotation marks are

obligatory) enables the application's export mode. This way, the current

settings of the document are exported to the template file. There will

be no updating of the document. The path of the template file to write

is always derived from the path of the document by simply appending the

extension .ini. Attention: An existing will be overwritten without any

query.

-tm, -TemplateMask "TemplateMask"

bit mask controlling which sections (if existent) of the template file

are to be processed; these bits are represented by a single character in

TemplateMask with an occurrence of the character being interpreted as 1

(= process section) and its absence as 0 (= ignore section):

i metadata

v viewer preferences

l page labels

t page transitions for slide show

o bookmarks

Note that this mask is case-sensitive. Omitting this parameters results

in processing all available sections of the template file.

-st, -SummaryTemplate "SummaryTemplate"

string with variables used to print information about a PDF document;

the exact form of this string is discussed in the subsection about

summary templates

Giving this parameters puts the application into summary mode. In this

mode, a user-defined summary about each processed document is generated.

None of the processed documents will be updated.

-sf, -SummaryFile "SummaryTemplateFile"

path to a text file (TXT, HTML, XML, usw.) from which the summary

template is loaded; the exact form of the file's contents is discussed

in the subsection about summary templates

Giving this parameters puts the application into summary mode. In this

mode, a user-defined summary about each processed document is generated.

None of the processed documents will be updated.

-so, -SummaryOutput "SummaryOutput"

path to a output file for the summary mode which is relative to the

current working directory; three cases are distinguished regarding the

value of SummaryOutput:

a) device name CON:

b) static path name

c) dynamic path name

Giving the case-insensitive device name CON: (including the trailing

colon) causes the summary to be printed on the console. In this special

case, the application will not output the path names of the processed

documents as is usually the case. The concept of dynamic/static path

names is covered in a separate subsection below.

If using static path names, the output behaviour also depends on whether

the parameter PDF file specifies a search pattern using wildcards or

just a single file. In the first case, all summaries are appended to the

output file which is not even cleared before processing the first

document. In the last case, the output file is completely overwritten

with the summary of the one and only document processed.

In general, using a dynamic path name allows to store the summary of

each document in its own file. However, if the path name does not

contain the variable $FileTitle$ but only $Dir$ followed by a static

file name, the summaries of all documents within the same directory will

again be appended.

By default, all summaries get printed on the console.

-r, -Repair

opens the document in repair mode, explicitly specifying -EditMode 3 is

then not neccessary; after updating, the document is completely

rewritten so that it should open normally the next time

Note that although this flag implies setting the -EditMode to 3, the

effect is not the same. The flag -Repair enables the application's batch

mode while the parameter -EditMode 3 merely specifies how to open a

document and does not prevent the application to use interactive mode.

-f

prevents automatically updating the file identifier when modifying a document

-q, -Quiet

prevents the display of dialog-based error/status messages when in batch

mode; for password-protected documents this flag also prevents

interactive password input from the user so that documents cannot be

opened unless their password is given by the -pwd parameter. output to

the console is not affected by this option

-v, -Version

outputs the version of the application on the console using the format

major.minor.build.revision; this flag suppresses all other parameters,

i. e. there will never be a document processing

-?, -Help

displays this help; this flag suppresses all other parameters, i. e.

there will never be a document processing

All parameter values are subject to the usual encoding rules for

command-lines: If it contains spaces the value is to be enclosed in

double quotation marks ("). If the value itself already contains

quotation marks each of them is to be escaped by a preceding backslash

(\).

Long or short options can be arbitrarily mixed on the command-line.

There is no need for a consistent usage.

Attention: In contrast to the long options, the short options are case-

sensitive.

If PDF file is given without any request to update its contents, the

application starts in interactive dialog mode as usual and opens the

specified file.

Giving one of the parameters -Title, -Subject, -Author, -Keywords, -

Creator, -Produder, -Created or -Modified without a value will cause the

corresponding metadata to be deleted. Giving -HideToolbar, -HideMenubar,

-HideWindowUI, -CenterWindow, -FitWindow or -DisplayDocTitle without

value is equal to giving the Mode 1.

Note that encrypting a document requires a complete rewrite of the file.

Therefore, when giving one of the encryption related paramters the

application does not perform an incremental update but rewrites the

entire file; explicitly giving -EditMode 2 is then not neccessary. All

previously made incremental updates will be irreversibly merged into a

single new edition of the document.

Tip: Giving the command -Encrypt 0 forces the regeneration of the

document in batch mode without changing the current encryption.

Attention: Care must be taken to use the proper code-page when writing

batch files. Batch files are run from DOS boxes which use the OEM code-

page while Windows applications use the ANSI code-page. As long as the

parameter values passed onto the application's command-line are

restricted to the ASCII character set, the difference does not matter.

However, if the batch file uses extended characters (e. g. characters

with accents) the use of the OEM code-page is required. The DOS editior

edit is recommened for writing batch files because it will use the OEM

code-page and is available on all Windows versions (just type edit on

the command prompt).

2.2 Exitcode / Output

Independant from the option -Quiet, the application returns a positive

exit code in case of an error. Batch files can evaluate this exit code

using the DOS statement IF ERRORLEVEL 1 Command. When updating multiple

documents using wildcards, only the first encountered error is returned

(unless cancelled by the user or when using -Quiet, the application will

continue to process the remaining documents). Success is indicated by

exit code 0.

The application outputs the file name of each processed input document

(line by line) when in batch mode. All file names are relative to the

base directory of the search pattern which is not neccessarily the

current working directory. This is specially useful for checking whether

all intended documents have been processed when using wildcards.

Note: For technical reasons, GUI applications cannot directly write to

the console of the hosting DOS box. To enable the hybrid functionality

of the application as both a GUI and a console tool, the actual program

file (EXE file) is accompanied by a console wrapper (COM file). Now when

calling the application from DOS boxes by just giving its name (i. e.

without the file extension ".exe"), DOS will by default call the COM

file which in turn calls the EXE file and finally redirects the output

from the EXE to the console window.

Tip: By default, the setup will place the EXE and COM file together in

the application directory. However, this constellation is not required

for the COM file to find the EXE file. The COM file might also be placed

within a directory listed by the environment variable PATH (e. g. the

Windows directory). This way the application can be run from DOS boxes

just by typing BeCyPDFMetaEdit and without giving a full path. For all

this to work properly an additional entry to the Windows registry is

required which is automatically created by the setup.

2.3 Dynamic Path Names

Some parameters accept so called dynamic path names in order to offer

flexible reactions when processing multiple documents using wildcards.

These are path names that contain one of the following variables whose

recognition is case-sensitive:

- $FileTitle$

- $Dir$

In contrast, path names without any such variables are called static

path names.

The variables are evaluated using a concrete path and are accordingly

replaced. The variable $FileTitle$ gets replaced with the title of a

file, that is its path name without the directory part and without the

file extension. The variable $Dir$ is replaced with the relative

directory path that may but need not be followed by a directory

separator. The combination $Dir$\$FileTitle$ results in the relative

path name to the currently processed document, only the file extension

is omitted.

As an example, consider the current working directory of the application

is "C:\Temp" and the document "C:\Temp\Demo\Intro.pdf" is being

processed. Then $FileTitle$ resolves to the value "Intro" and $Dir$ is

replaced with "Demo\".

2.4 Summary Templates

To produce the output during summary mode, the application employs

simple text templates with embedded variables. Later on when creating a

summary, the variables are replaced with concrete data about a document.

All variables are enclosed between dollar signs ($) and have the

following form:

$Keyword [Width] [Style]$

The delimiting dollar signs can freely be used outside variables. If

none of the supported keywords is recognized immediately after a dollar

sign, it is automatically interpreted as an ordinary text character.

The mandatory Keyword determines which information about a PDF document

is to be inserted at the position of the variable. Currently, the

following case-sensitive keywords are supported:

PathName

full path to document

Directory, FileTitle, FileExt

directory, file title and file extension of document

FileSize

file size of document

Edition

edition of document

Version

PDF version of document

MajorID

major id of document

MinorID

minor id of document

Pages

page count of document

Author

author of document

Title

title of document

Subject

subject of document

Keywords

keywords of document

Created

creation date of document

Modified

modifcation date of document

Creator

creating application of document

Producer

producing application of document

Using the optional parameter Width, the minimum length of the output and

its alignment can be controlled. The absolute value of this numeric

input specifies the minimum number of text character to output. If the

original output is too short, it is padded with space characters. The

sign of the value determines the alignment. For positive values the

output is left aligned, for negative values the output is right aligned.

The default value is 0.

The optional parameter Style selects one of the possible output formats

for a specific information and consists of a single lower-case

character. For many keywords, this parameter has no effect and is

treated the same as the default value a. The style is only relevant for

the following keywords:

FileSize

a automatic output of # Byte, # KB or # MB where # is the up-rounded integral value

b integral number of bytes without output of unit

c up-rounded integral number of kilobytes without output of unit

d up-rounded integral number of megabytes without output of unit

Created, Modified

a short and localized output of date and time

b short and localized output of date

c short and localized output of time

d long and localized output of date and time

e long and localized output of date

f long and localized output of time

g international output of date/time using the format yyyy-MM-ddThh:mm:ss

h international output of date using the format yyyy-MM-dd

i international output of time using the format hh:mm:ss

When giving the summary template directly on the command-line, two

consecutive slashes (//) can be used in order to insert a line break in

the text.

For summary templates loaded from text files, the character encodings

ANSI, UTF-8 and UTF-16 can be used.

2.5 Examples

Note: The line breaks in the following examples have only been inserted

to improve readability and are not part of the actual command-line.

The following example changes the title of the document Test.pdf to

Demonstration, removes the field about the creator and sets the creation

date to 06/14/2005 01:25:00 pm. Furthermore, the toolbar of the PDf

viewer is hidden and the initial page mode is set to fullscreen. The

following page labels are created: the first 11 pages of the document

are numbered with roman lowercase letters, pages 12 to 383 are numbered

with arabic decimal number and the last pages from 384 on are numbered

with decimal numbers of the form A-1, A-2, etc. The modification date

and the file identifier are automatically updated. Error-boxes are

suppressed:

> BeCyPDFMetaEdit "E:\My Documents\Test.pdf" -T "Demonstration" -R

-C "D:20050614132500" -HT -PM 4 -pl 1r -pl 12D -pl 384D1A- -quiet

The next example sets the title of all PDF documents within the

directory E:\Documents to "Demo". Note the backslashes that escape the

quotation marks in the title value. Error-boxes or password queries are

not suppressed, the XMP metadata is removed:

> BeCyPDFMetaEdit "E:\Documents\*.pdf" -T "\"Demo\"" -X 1

The example below sets the metadata and the viewer preferences for the

document Test.pdf according to the template Test.ini. However, the title

is always set to Demonstration regardless of the template's contents:

> BeCyPDFMetaEdit "Test.pdf" -tf "Test.ini" -tm "iv" -T "Demonstration"

This example exports the metadata and bookmarks from the document

Test.pdf into the template file Test.pdf.ini. The PDF document itself is

not altered. The parameter -M auto enforces the export of the special

value Auto instead of the actual modification date:

> BeCyPDFMetaEdit "Test.pdf" -tf ">" -tm "io" -M auto

The following dumps a summary of all PDF documents in the current

working directory and all its sub directories to the console using one

line per document where each line gives the file title (left-aligned

within field of 50 characters), the file size (right-aligned within

field of 10 characters) and the date of the last modification of a

document:

> BeCyPDFMetaEdit "*.pdf" -s -st "$FileTitle 50$ $FileSize -10$ $Modified

b$//"

The last example tries to repair the document Bad.pdf and to restore a

proper file structure::

> BeCyPDFMetaEdit "Bad.pdf" -r