summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/gtk4-encode-symbolic-svg.xml
blob: 330795bc92f48148d79e7d2ccec2f14f3596ff02 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
]>
<refentry id="gtk4-encode-symbolic-svg">

<refentryinfo>
  <title>gtk4-encode-symbolic-svg</title>
  <productname>GTK</productname>
  <authorgroup>
    <author>
      <contrib>Developer</contrib>
      <firstname>Alexander</firstname>
      <surname>Larsson</surname>
    </author>
  </authorgroup>
</refentryinfo>

<refmeta>
  <refentrytitle>gtk4-encode-symbolic-svg</refentrytitle>
  <manvolnum>1</manvolnum>
  <refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>

<refnamediv>
  <refname>gtk4-encode-symbolic-svg</refname>
  <refpurpose>Symbolic icon conversion utility</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>gtk4-encode-symbolic-svg</command>
<arg choice="opt">OPTION...</arg>
<arg choice="plain"><replaceable>PATH</replaceable></arg>
<arg choice="plain"><replaceable>WIDTH</replaceable>x<replaceable>HEIGHT</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1><title>Description</title>
<para>
  <command>gtk4-encode-symbolic-svg</command> converts symbolic svg icons into
  specially prepared png files. GTK can load and recolor these pngs, just like
  original svgs, but loading them is much faster.
</para>
<para>
  <replaceable>PATH</replaceable> is the name of a symbolic svg file,
  <replaceable>WIDTH</replaceable>x<replaceable>HEIGHT</replaceable> are the
  desired dimensions for the generated png file.
</para>
<para>
  To distinguish them from ordinary pngs, the generated files have the extension
  <filename>.symbolic.png</filename>.
</para>
</refsect1>

<refsect1><title>Options</title>
<variablelist>
  <varlistentry>
    <term>-o <replaceable>DIRECTORY</replaceable></term>
    <term>--output <replaceable>DIRECTORY</replaceable></term>
    <listitem><para>Write png files to <replaceable>DIRECTORY</replaceable>
         instead of the current working directory.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term>--debug</term>
    <listitem><para>Generate png files of the various channels during
         the conversion. If these files are not monochrome green, they
         are often helpful in pinpointing the problematic parts of
         the source svg.</para></listitem>
  </varlistentry>
</variablelist>
</refsect1>

</refentry>