SkimNotes_Tool Log in to Edit
General Usage
These are usage notes for the skimnotes command line tool version 2.10.
Summary
Usage:
skimnotes get [-format skim|archive|plist|text|rtf] PDF_FILE [NOTES_FILE|-]
skimnotes set [-s|-n] PDF_FILE [SKIM_FILE|-] [TEXT_FILE] [RTF_FILE]
skimnotes remove PDF_FILE
skimnotes test [-s|-n] PDF_FILE
skimnotes convert [-s|-n] IN_PDF_FILE [OUT_PDF_FILE]
skimnotes format archive|plist|text|rtf IN_SKIM_FILE|- [OUT_FILE|-]
skimnotes offset IN_SKIM_FILE|- [OUT_SKIM_FILE|-]
skimnotes agent [-xpc] [SERVER_NAME]
skimnotes protocol [-xpc]
skimnotes help [VERB]
skimnotes version
Get
Read Skim notes from a PDF
Usage:
skimnotes get [-format skim|archive|plist|text|rtf] PDF_FILE [NOTES_FILE|-]
Reads Skim, Text, or RTF notes from extended attributes of PDF_FILE or the contents of PDF bundle PDF_FILE and writes to NOTES_FILE or standard output. Uses notes file with same base name as PDF_FILE if SKIM_FILE is not provided. Reads Skim notes when no format is provided.
Set
Write Skim notes to a PDF
Usage:
skimnotes set [-s|-n] PDF_FILE [SKIM_FILE|-] [TEXT_FILE] [RTF_FILE]
Writes notes to extended attributes of PDF_FILE or the contents of PDF bundle PDF_FILE from SKIM_FILE or standard input. Uses notes file with same base name as PDF_FILE if SKIM_FILE is not provided. Writes a default form for the text formats based on the contents of SKIM_FILE if TEXT_FILE and/or RTF_FILE are not provided. Writes (non) syncable notes when the -s (-n) option is provided, defaults to syncable.
Remove
Delete Skim notes from a PDF
Usage:
skimnotes remove PDF_FILE
Removes the Skim notes from the extended attributes of PDF_FILE or from the contents of PDF bundle PDF_FILE.
Test
Tests whether a PDF file has Skim notes
Usage:
skimnotes test [-s|-n] PDF_FILE
Returns a zero (true) exit status when the extended attributes of PDF_FILE or the contents of PDF bundle PDF_FILE contain Skim notes, otherwise return 1 (false). Tests only (non) syncable notes when the -s (-n) option is provided.
Convert
Convert between a PDF file and a PDF bundle
Usage:
skimnotes convert [-s|-n] IN_PDF_FILE [OUT_PDF_FILE]
Converts a PDF file IN_PDF_FILE to a PDF bundle OUT_PDF_FILE or a PDF bundle IN_PDF_FILE to a PDF file OUT_PDF_FILE, or changes the syncability of the notes. Uses a file with same base name but different extension as IN_PDF_FILE if OUT_PDF_FILE is not provided. Writes (non) syncable notes when the -s (-n) option is provided, defaults to syncable.
Format
Formats Skim notes data as archive, plist, text, or RTF data
Usage:
skimnotes format archive|plist|text|rtf IN_SKIM_FILE|- [OUT_FILE|-]
Format the notes data IN_SKIM_FILE or standard input to archive, plist, text, or RTF format and writes the result to OUT_FILE or standard output. Writes back to a file with the same base name as IN_SKIM_FILE (or standard output) if OUT_FILE is not provided. Archive and plist data can be used as the format for .skim files or attached to PDFs
Offset
Offsets all notes in a SKIM file by a fixed amount
Usage:
skimnotes offset DX DY IN_SKIM_FILE|- [OUT_SKIM_FILE|-]
Offsets all notes in IN_SKIM_FILE or standard input by an amount (DX, DY) and writes the result to OUT_SKIM_FILE or standard output. Writes back to IN_SKIM_FILE (or standard output) if OUT_SKIM_FILE is not provided.
Agent
Run the Skim Notes agent
Usage:
skimnotes agent [-xpc] [SERVER_NAME]
Runs a Skim Notes agent server with server name SERVER_NAME, to which a Cocoa application can connect using DO. When SERVER_NAME is not provided, a unique name is generated and returned on standard output. The DO server conforms to the following formal protocol.
Runs a Skim Notes agent server with server name SERVER_NAME, to which a Cocoa application can connect using DO.
Runs a XPC based agent when the -xpc option is provided.
When SERVER_NAME is not provided, a unique name is generated and returned on standard output.
The DO server conforms to the formal protocol returned by the protocol action.
@protocol SKAgentListenerProtocol
- (bycopy NSData *)SkimNotesAtPath:(in bycopy NSString *)aFile;
- (bycopy NSData *)RTFNotesAtPath:(in bycopy NSString *)aFile;
- (bycopy NSData *)textNotesAtPath:(in bycopy NSString *)aFile encoding:(NSStringEncoding)encoding;
@end
The XPC DO server conforms to the formal protocol returned by the protocol action.
@protocol SKAgentListenerProtocol
- (void)readSkimNotesAttURL:(NSURL *)aURL reply:(void (^)(NSData * _Nullable))reply;
- (void)readRTFNotesAtURL:(NSURL *)aURL reply:(void (^)(NSData * _Nullable))reply;
- (void)readTextNotesAtURL:(NSURL *)aURL reply:(void (^)(NSString * _Nullable))reply;
@end
Protocol
Write the agent protocol
Usage:
skimnotes protocol [-xpc]
Writes the protocol for the DO server from the skimnotes agent to standard output.
Returns a protocol for a XPC connection when the -xpc option is provided.
Help
Get help on the skimnotes tool
Usage:
skimnotes help [VERB]
Get help on the verb VERB.
Version
Get version of the skimnotes tool
Usage:
skimnotes version
Get the version of the tool and exit.
