Skip to content

Commit

Permalink
Update docos and DLL exports.
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelrsweet committed Oct 28, 2023
1 parent 0242d2b commit 49f9a0c
Show file tree
Hide file tree
Showing 10 changed files with 113 additions and 138 deletions.
130 changes: 51 additions & 79 deletions doc/pappl.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion man/pappl-client.3
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH pappl-client 3 "pappl client functions" "2023-10-06" "pappl client functions"
.TH pappl-client 3 "pappl client functions" "2023-10-28" "pappl client functions"
.SH NAME
pappl-client \- pappl client functions
.SH LIBRARY
Expand Down
23 changes: 13 additions & 10 deletions man/pappl-device.3
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH pappl-device 3 "pappl device functions" "2023-10-06" "pappl device functions"
.TH pappl-device 3 "pappl device functions" "2023-10-28" "pappl device functions"
.SH NAME
pappl-device \- pappl device functions
.SH LIBRARY
Expand Down Expand Up @@ -125,13 +125,17 @@ PAPPL_DEVTYPE_FILE
.br
Local file/directory
.TP 5
PAPPL_DEVTYPE_IPP
.br
IPP/IPPS printers
.TP 5
PAPPL_DEVTYPE_LOCAL
.br
All local printers
.TP 5
PAPPL_DEVTYPE_NETWORK
.br
All network printers
All network printers except IPP
.TP 5
PAPPL_DEVTYPE_SNMP
.br
Expand Down Expand Up @@ -459,23 +463,22 @@ Open a connection to a device.
.nf
pappl_device_t * papplDeviceOpen (
const char *device_uri,
const char *name,
pappl_job_t *job,
pappl_deverror_cb_t err_cb,
void *err_data
);
.fi
.PP
This function opens a connection to the specified device URI. The "name"
argument provides textual context for the connection and is usually the name
(title) of the print job.
This function opens a connection to the specified device URI. The "job"
argument provides the job associated with the connection.
.PP
Any errors are reported using the supplied "err_cb" function. If you specify
\fBNULL\fR for this argument, errors are sent to \fBstderr\fR.
.SS papplDeviceParseID
Parse an IEEE-1284 device ID string.
.PP
.nf
int papplDeviceParseID (
size_t papplDeviceParseID (
const char *device_id,
cups_option_t **pairs
);
Expand Down Expand Up @@ -606,7 +609,7 @@ typedef void (*pappl_devclose_cb_t)(pappl_device_t *device);
Device error callback
.PP
.nf
typedef void (*pappl_deverror_cb_t)(const char *message, void *err_data);
typedef void (*pappl_deverror_cb_t)(void *err_data, const char *message);
.fi
.SS pappl_device_cb_t
Device callback - return \fBtrue\fR to stop, \fBfalse\fR to continue
Expand All @@ -624,7 +627,7 @@ typedef char * (*pappl_devid_cb_t)(pappl_device_t *device, char *buffer, size_t
Device list callback
.PP
.nf
typedef bool (*pappl_devlist_cb_t)(pappl_device_cb_t cb, void *data, pappl_deverror_cb_t err_cb, void *err_data);
typedef bool (*pappl_devlist_cb_t)(pappl_devtype_t types, pappl_device_cb_t cb, void *data, pappl_deverror_cb_t err_cb, void *err_data);
.fi
.SS pappl_devmetrics_t
Device metrics
Expand All @@ -636,7 +639,7 @@ typedef struct pappl_devmetrics_s pappl_devmetrics_t;
Device open callback
.PP
.nf
typedef bool (*pappl_devopen_cb_t)(pappl_device_t *device, const char *device_uri, const char *name);
typedef bool (*pappl_devopen_cb_t)(pappl_device_t *device, const char *device_uri, pappl_job_t *job);
.fi
.SS pappl_devread_cb_t
Device read callback
Expand Down
2 changes: 1 addition & 1 deletion man/pappl-job.3
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH pappl-job 3 "pappl job functions" "2023-10-06" "pappl job functions"
.TH pappl-job 3 "pappl job functions" "2023-10-28" "pappl job functions"
.SH NAME
pappl-job \- pappl job functions
.SH LIBRARY
Expand Down
6 changes: 3 additions & 3 deletions man/pappl-log.3
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH pappl-log 3 "pappl logging functions" "2023-10-06" "pappl logging functions"
.TH pappl-log 3 "pappl logging functions" "2023-10-28" "pappl logging functions"
.SH NAME
pappl-log \- pappl logging functions
.SH LIBRARY
Expand Down Expand Up @@ -135,8 +135,8 @@ Log a device error for the system...
.PP
.nf
void papplLogDevice (
const char *message,
void *data
void *data,
const char *message
);
.fi
.PP
Expand Down
8 changes: 4 additions & 4 deletions man/pappl-mainloop.3
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH pappl-mainloop 3 "pappl main loop functions" "2023-10-06" "pappl main loop functions"
.TH pappl-mainloop 3 "pappl main loop functions" "2023-10-28" "pappl main loop functions"
.SH NAME
pappl-mainloop \- pappl main loop functions
.SH LIBRARY
Expand All @@ -23,7 +23,7 @@ int papplMainloop (
char *argv[],
const char *version,
const char *footer_html,
int num_drivers,
size_t num_drivers,
pappl_pr_driver_t *drivers,
pappl_pr_autoadd_cb_t autoadd_cb,
pappl_pr_driver_cb_t driver_cb,
Expand Down Expand Up @@ -77,13 +77,13 @@ shutdown.
Sub-command callback
.PP
.nf
typedef int (*pappl_ml_subcmd_cb_t)(const char *base_name, int num_options, cups_option_t *options, int num_files, char **files, void *data);
typedef int (*pappl_ml_subcmd_cb_t)(const char *base_name, size_t num_options, cups_option_t *options, size_t num_files, char **files, void *data);
.fi
.SS pappl_ml_system_cb_t
System callback
.PP
.nf
typedef pappl_system_t * (*pappl_ml_system_cb_t)(int num_options, cups_option_t *options, void *data);
typedef pappl_system_t * (*pappl_ml_system_cb_t)(size_t num_options, cups_option_t *options, void *data);
.fi
.SS pappl_ml_usage_cb_t
Program usage callback
Expand Down
60 changes: 30 additions & 30 deletions man/pappl-printer.3
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH pappl-printer 3 "pappl printer functions" "2023-10-06" "pappl printer functions"
.TH pappl-printer 3 "pappl printer functions" "2023-10-28" "pappl printer functions"
.SH NAME
pappl-printer \- pappl printer functions
.SH LIBRARY
Expand Down Expand Up @@ -904,7 +904,7 @@ Get the maximum number of active (queued)
jobs allowed by the printer.
.PP
.nf
int papplPrinterGetMaxActiveJobs (
size_t papplPrinterGetMaxActiveJobs (
pappl_printer_t *printer
);
.fi
Expand All @@ -916,7 +916,7 @@ Get the maximum number of jobs retained
for history by the printer.
.PP
.nf
int papplPrinterGetMaxCompletedJobs (
size_t papplPrinterGetMaxCompletedJobs (
pappl_printer_t *printer
);
.fi
Expand All @@ -929,7 +929,7 @@ Get the maximum number of jobs
preserved by the printer.
.PP
.nf
int papplPrinterGetMaxPreservedJobs (
size_t papplPrinterGetMaxPreservedJobs (
pappl_printer_t *printer
);
.fi
Expand Down Expand Up @@ -962,7 +962,7 @@ the next job that is created.
Get the number of active print jobs.
.PP
.nf
int papplPrinterGetNumberOfActiveJobs (
size_t papplPrinterGetNumberOfActiveJobs (
pappl_printer_t *printer
);
.fi
Expand All @@ -974,7 +974,7 @@ Get the number of completed print
jobs.
.PP
.nf
int papplPrinterGetNumberOfCompletedJobs (
size_t papplPrinterGetNumberOfCompletedJobs (
pappl_printer_t *printer
);
.fi
Expand All @@ -985,7 +985,7 @@ canceled, or completed.
Get the total number of print jobs.
.PP
.nf
int papplPrinterGetNumberOfJobs (
size_t papplPrinterGetNumberOfJobs (
pappl_printer_t *printer
);
.fi
Expand Down Expand Up @@ -1081,9 +1081,9 @@ This function returns the current printer state as an enumeration:
Get the current "printer-supplies" values.
.PP
.nf
int papplPrinterGetSupplies (
size_t papplPrinterGetSupplies (
pappl_printer_t *printer,
int max_supplies,
size_t max_supplies,
pappl_supply_t *supplies
);
.fi
Expand Down Expand Up @@ -1158,8 +1158,8 @@ void papplPrinterIterateActiveJobs (
pappl_printer_t *printer,
pappl_job_cb_t cb,
void *data,
int job_index,
int limit
size_t job_index,
size_t limit
);
.fi
.PP
Expand All @@ -1178,8 +1178,8 @@ void papplPrinterIterateAllJobs (
pappl_printer_t *printer,
pappl_job_cb_t cb,
void *data,
int job_index,
int limit
size_t job_index,
size_t limit
);
.fi
.PP
Expand All @@ -1197,8 +1197,8 @@ void papplPrinterIterateCompletedJobs (
pappl_printer_t *printer,
pappl_job_cb_t cb,
void *data,
int job_index,
int limit
size_t job_index,
size_t limit
);
.fi
.PP
Expand Down Expand Up @@ -1339,7 +1339,7 @@ Set the default print option values.
bool papplPrinterSetDriverDefaults (
pappl_printer_t *printer,
pappl_pr_driver_data_t *data,
int num_vendor,
size_t num_vendor,
cups_option_t *vendor
);
.fi
Expand Down Expand Up @@ -1396,7 +1396,7 @@ Set the maximum number of active jobs for
.nf
void papplPrinterSetMaxActiveJobs (
pappl_printer_t *printer,
int max_active_jobs
size_t max_active_jobs
);
.fi
.PP
Expand All @@ -1414,7 +1414,7 @@ Set the maximum number of completed
.nf
void papplPrinterSetMaxCompletedJobs (
pappl_printer_t *printer,
int max_completed_jobs
size_t max_completed_jobs
);
.fi
.PP
Expand All @@ -1427,7 +1427,7 @@ Set the maximum number of preserved
.nf
void papplPrinterSetMaxPreservedJobs (
pappl_printer_t *printer,
int max_preserved_jobs
size_t max_preserved_jobs
);
.fi
.PP
Expand Down Expand Up @@ -1497,7 +1497,7 @@ Set the ready (loaded) media.
.nf
bool papplPrinterSetReadyMedia (
pappl_printer_t *printer,
int num_ready,
size_t num_ready,
pappl_media_col_t *ready
);
.fi
Expand All @@ -1524,7 +1524,7 @@ Set/update the supplies for a printer.
.nf
void papplPrinterSetSupplies (
pappl_printer_t *printer,
int num_supplies,
size_t num_supplies,
pappl_supply_t *supplies
);
.fi
Expand Down Expand Up @@ -1597,7 +1597,7 @@ Printer driver data
struct pappl_pr_driver_data_s
{
const char *bin[PAPPL_MAX_BIN];
int bin_default;
size_t bin_default;
bool borderless;
int bottom_top;
pappl_color_mode_t color_default;
Expand Down Expand Up @@ -1629,13 +1629,13 @@ struct pappl_pr_driver_data_s
pappl_media_col_t media_ready[PAPPL_MAX_SOURCE];
pappl_label_mode_t mode_configured;
pappl_label_mode_t mode_supported;
int num_bin;
int num_features;
int num_media;
int num_resolution;
int num_source;
int num_type;
int num_vendor;
size_t num_bin;
size_t num_features;
size_t num_media;
size_t num_resolution;
size_t num_source;
size_t num_type;
size_t num_vendor;
ipp_orient_t orient_default;
bool output_face_up;
pappl_dither_t pdither;
Expand Down Expand Up @@ -1684,7 +1684,7 @@ struct pappl_pr_options_s
unsigned last_page;
pappl_media_col_t media;
unsigned num_pages;
int num_vendor;
size_t num_vendor;
ipp_orient_t orientation_requested;
char output_bin[64];
pappl_color_mode_t print_color_mode;
Expand Down
2 changes: 1 addition & 1 deletion man/pappl-resource.3
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH pappl-resource 3 "pappl resource functions" "2023-10-06" "pappl resource functions"
.TH pappl-resource 3 "pappl resource functions" "2023-10-28" "pappl resource functions"
.SH NAME
pappl-resource \- pappl resource functions
.SH LIBRARY
Expand Down
Loading

0 comments on commit 49f9a0c

Please sign in to comment.