Package: scour
Version: 0.38.2-2
Severity: normal

Dear Maintainer,

The scour package has no man page. I have made one, based on the readme and the
output of scour --help.


-- System Information:
Debian Release: 12.12
  APT prefers oldstable-updates
  APT policy: (500, 'oldstable-updates'), (500, 'oldstable-security'), (500, 
'oldstable')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 6.1.0-41-amd64 (SMP w/8 CPU threads; PREEMPT)
Locale: LANG=en_GB.UTF-8, LC_CTYPE=en_GB.UTF-8 (charmap=UTF-8), 
LANGUAGE=en_GB:en
Shell: /bin/sh linked to /usr/bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

Versions of packages scour depends on:
ii  python3        3.11.2-1+b1
ii  python3-scour  0.38.2-2

scour recommends no packages.

Versions of packages scour suggests:
ii  gir1.2-rsvg-2.0   2.54.7+dfsg-1~deb12u1
ii  python3-gi-cairo  3.42.2-3+b1

-- no debconf information

*** /home/marnanel/src/scour/scour.1
.TH scour 1 "Date: 2025/12/15 22:45:00" "Scour"
.SH NAME
scour \-  an SVG optimiser and cleaner
.SH SYNOPSIS
.TP
\fBscour\fP \fB[\fP \fIoptions\fP \fB... ]\fP \fIinput.svg output.svg\fP
.SH DESCRIPTION
\fBscour\fP is an SVG optimizer/cleaner written in Python that reduces
the size of scalable vector graphics by optimizing structure and removing 
unnecessary data.

It can be used to create streamlined vector graphics suitable
for web deployment, publishing/sharing or further processing.

The goal of \fBscour\fP is to output a file that renders identically at a 
fraction of the size
by removing a lot of redundant information created by most SVG editors. 
Optimization
options are typically lossless but can be tweaked for more aggressive cleaning.

.SH OPTIONS

If the input/output files are not specified, stdin/stdout are used. If the
input/output files are specified with a \fB.svgz\fP extension, then compressed 
SVG is
assumed.

.TP 15
.B --version
show program's version number and exit
  
.TP
.B -h, --help
show this help message and exit

.TP
.B -q, --quiet
suppress non-error output

.TP
.B -v, --verbose
verbose output (statistics, etc.)

.TP
.B -i INPUT.SVG
alternative way to specify input filename

.TP
.B -o OUTPUT.SVG
alternative way to specify output filename
.PD

.SS Optimization
.TP 15
.B --set-precision=NUM
set number of significant digits (default: 5)

.TP
.B --set-c-precision=NUM
set number of significant digits for control points (default: same as 
\fI--set-precision\fP)

.TP
.B --disable-simplify-colors
won't convert colors to \fI#RRGGBB\fP format

.TP
.B --disable-style-to-xml
won't convert styles into XML attributes

.TP
.B --disable-group-collapsing
won't collapse \fI<g>\fP elements

.TP
.B --create-groups
create \fI<g>\fP elements for runs of elements with identical attributes

.TP
.B --keep-editor-data
won't remove Inkscape, Sodipodi, Adobe Illustrator or Sketch elements and 
attributes

.TP
.B --keep-unreferenced-defs
won't remove elements within the defs container that are unreferenced

.TP
.B --renderer-workaround
work around various renderer bugs (currently only librsvg) (default)

.TP
.B --no-renderer-workaround
do not work around various renderer bugs (currently only librsvg)
.PD

.SS  SVG document
.TP 15

.B --strip-xml-prolog
won't output the XML prolog (\fI<?xml ?>\fP)

.TP
.B --remove-titles
remove \fI<title>\fP elements

.TP
.B --remove-descriptions
remove \fI<desc>\fP elements

.TP
.B --remove-metadata
remove \fI<metadata>\fP elements (which may contain license/author information 
etc.)

.TP
.B --remove-descriptive-elements
remove \fI<title>\fP, \fI<desc>\fP and \fI<metadata>\fP elements


.TP
.B --enable-comment-stripping
remove all comments (\fI<!-- -->\fP)


.TP
.B --disable-embed-rasters
won't embed rasters as base64-encoded data


.TP
.B --enable-viewboxing
changes document width/height to 100%/100% and creates viewbox coordinates
.PD

.SS Output formatting
.TP 15


.B --indent=TYPE
indentation of the output: none, space, tab (default: space)


.TP
.B --nindent=NUM
depth of the indentation, i.e. number of spaces/tabs: (default: 1)


.TP
.B --no-line-breaks
do not create line breaks in output (also disables indentation; might be 
overridden by \fIxml:space="preserve"\fP)


.TP
.B --strip-xml-space
strip the \fIxml:space="preserve"\fP attribute from the root SVG element
.PD

.SS ID attributes
.TP 15


.B --enable-id-stripping
remove all unreferenced IDs


.TP
.B --shorten-ids
shorten all IDs to the least number of letters possible


.TP
.B --shorten-ids-prefix=PREFIX
add custom prefix to shortened IDs


.TP
.B --protect-ids-noninkscape
don't remove IDs not ending with a digit


.TP
.B --protect-ids-list=LIST
don't remove IDs given in this comma-separated list


.TP
.B --protect-ids-prefix=PREFIX
don't remove IDs starting with the given prefix
.PD

.SS SVG compatibility checks
.TP 15

.B --error-on-flowtext
exit with error if the input SVG uses non-standard flowing text (only warn by 
default)
.PD

.SH EXAMPLES

.IP "\(bu" 4
Standard:

.PP
.Vb 1
\&        scour -i input.svg -o output.svg
.Ve
.PP

.IP "\(bu" 4
Better (for older versions of Internet Explorer):

.PP
.Vb 1
\&        scour -i input.svg -o output.svg --enable-viewboxing
.Ve
.PP

.IP "\(bu" 4
Maximum scrubbing:

.PP
.Vb 1
\&        scour -i input.svg -o output.svg --enable-viewboxing 
--enable-id-stripping --enable-comment-stripping --shorten-ids --indent=none
.Ve
.PP

.IP "\(bu" 4
Maximum scrubbing and a compressed SVGZ file:

.PP
.Vb 1
\&        scour -i input.svg -o output.svgz --enable-viewboxing 
--enable-id-stripping --enable-comment-stripping --shorten-ids --indent=none
.Ve
.PP

.SH AUTHORS
\fBscour\fP was originally developed by Jeff "codedread" Schiller and Louis 
Simard in in 2010.

The project moved to GitLab in 2013 and is now maintained by Tobias "oberstet" 
Oberstein and Patrick "Ede_123" Storz.

.SH COPYRIGHT

Copyright Jeff Schiller, Louis Simard, 2010.
\fBscour\fP is open-source and licensed under Apache License 2.0.

Reply via email to