uca

README

uca-print

uca-print is a set of tools to print documents from the command-line.

Installation

$> go install git.sr.ht/~sbinet/uca-print/cmd/uca-print

Examples

$> uca-print -h
Usage: uca-print [options] file1.pdf [file2.odt [...]]

ex:
 $> uca-print ./file1.pdf
 $> uca-print -u username ./file1.pdf ./file2.pdf
 $> uca-print -u username -p s3cr3t ./file1.pdf ./file2.pdf

options:
  -p string
    	password for papercut
  -t duration
    	timeout for sending files to print (default 20s)
  -u string
    	username for papercut

$> uca-print ./f1.pdf ./f2.pdf
uca-print: file: [ERR] "f1.pdf": Disallowed paper size: submission error
uca-print: file: [ OK] "f2.pdf"

$> echo $?
1

Credentials for uca-print can also be stored in $HOME/.config/uca-print/auth.cfg:

$> cat ~/.config/uca-print/auth.cfg
user     my-username
cred-cmd some authentication command # optional.

cred-cmd would typically point at, e.g.:

cred-cmd pass uca.fr/me

uca-print-srv

uca-print also provides a REST-like server that can forward printing requests:

$> go install git.sr.ht/~sbinet/uca-print/cmd/uca-print-srv
$> uca-print-srv -addr :8080 -cert ./cert/server.crt -priv ./cert/server.key

and, in another terminal:

$> curl -X POST \
    -k ## to allow self-signed certificates \
    -u username:s3cr3t \
    --form file='@path-to-file1.pdf' \
    --form file='@path-to-file2.pdf' \
    --form file='@path-to-file3.pdf' \
    https://localhost:8080

Documentation

Overview

Package uca provides tools to send files to print to papercut.

Index

• Variables
• type Client
  • func NewClient(opts ...Option) (*Client, error)
  • func (cli *Client) Close() (err error)
  • func (cli *Client) Printers(ctx context.Context) ([]Printer, error)
  • func (cli *Client) Send(ctx context.Context, fnames []string) ([]Report, error)
• type Option
  • func WithAuth(usr, pwd string) Option
  • func WithQueue(id string) Option
  • func WithUser(usr string) Option
• type Printer
• type Report

Variables

var (
	ErrUndefinedQueue = errors.New("printer queue undefined")
	ErrNoQueue        = errors.New("no such printer queue")
	ErrInvalidAuth    = errors.New("invalid authentication")
	ErrSubmission     = errors.New("submission error")
)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides a means to authenticate with and send files to a PaperCut web-print server.

func NewClient

func NewClient(opts ...Option) (*Client, error)

NewClient creates a new PaperCut client with the provided options.

By default, the client will try to locate the credentials file named $HOME/.config/uca-print/auth.cfg.

func (*Client) Close

func (cli *Client) Close() (err error)

func (*Client) Printers

func (cli *Client) Printers(ctx context.Context) ([]Printer, error)

Printers returns the list of known printer queues.

func (*Client) Send

func (cli *Client) Send(ctx context.Context, fnames []string) ([]Report, error)

Send sends the files to be printed to the web-print PaperCut server and returns back a status report for each of them.

type Option

type Option func(c *Client) error

Option configures a client.

func WithAuth

func WithAuth(usr, pwd string) Option

WithAuth provides the user+password authentication mechanism to a PaperCut web-print server.

func WithQueue

func WithQueue(id string) Option

WithQueue specifies which printer queue ID to use.

func WithUser

func WithUser(usr string) Option

WithUser provides the user name to authenticate with a PaperCut web-print server. The user is prompted to provide their password interactively.

type Printer

type Printer struct {
	ID   string
	Name string
}

type Report

type Report struct {
	File string
	Err  error
}

Report describes the result of a job submission to PaperCut.