1. Summary
  2. Files
  3. Support
  4. Report Spam
  5. Create account
  6. Log in

SkimNotes Tool

From skim-app

Jump to: navigation, search

Contents

General Usage

These are usage notes for the skimnotes command line tool version 2.2.

Summary

Usage:

skimnotes get [-format skim|text|rtf] PDF_FILE [NOTES_FILE|-]
skimnotes set PDF_FILE [SKIM_FILE|-] [TEXT_FILE] [RTF_FILE]
skimnotes remove PDF_FILE
skimnotes convert IN_PDF_FILE [OUT_PDF_FILE]
skimnotes agent [SERVER_NAME]
skimnotes protocol
skimnotes help [VERB]
skimnotes version

Get

Read Skim notes from a PDF

Usage:

skimnotes get [-format skim|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 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.

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.

Convert

Convert between a PDF file and a PDF bundle

Usage:

skimnotes convert 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. Uses a file with same base name as IN_PDF_FILE if OUT_PDF_FILE is not provided.

Agent

Run the Skim Notes agent

Usage:

skimnotes agent [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.

@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

Protocol

Write the agent protocol

Usage:

skimnotes protocol

Writes the protocol for the DO server from the skimnotes agent to standard output.

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.

Personal tools