From 8bf7187b89e85ead1a72c965e1d5c8aa79994364 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sat, 12 Aug 2023 19:29:27 -0400 Subject: [PATCH] path-tool: Make the docs match We've removed various things from the tool, and forgot to keep the docs up-to-date. --- docs/reference/gtk/gtk4-path-tool.rst | 112 ++++++++++++++++++++------ 1 file changed, 86 insertions(+), 26 deletions(-) diff --git a/docs/reference/gtk/gtk4-path-tool.rst b/docs/reference/gtk/gtk4-path-tool.rst index 3ee0d31d8d..1a7bbdf1ec 100644 --- a/docs/reference/gtk/gtk4-path-tool.rst +++ b/docs/reference/gtk/gtk4-path-tool.rst @@ -13,7 +13,6 @@ SYNOPSIS | **gtk4-path-tool** [OPTIONS...] | | **gtk4-path-tool** decompose [OPTIONS...] -| **gtk4-path-tool** restrict [OPTIONS...] | **gtk4-path-tool** show [OPTIONS...] | **gtk4-path-tool** render [OPTIONS...] | **gtk4-path-tool** info [OPTIONS...] @@ -37,31 +36,14 @@ The ``decompose`` command approximates the path by one with simpler elements. When used without options, the curves of the path are approximated by line segments. -``--allow-curves`` +``--allow-quad`` + + Allow quadratic Bézier curves to be used in the generated path. + +``--allow-cubic`` Allow cubic Bézier curves to be used in the generated path. -``--allow-conics`` - - Allow rational quadratic Bézier curves to be used in the generated path. - -Restricting -^^^^^^^^^^^ - -The ``restrict`` command creates a path that traces a segment of the original -path. Note that the start and the end of the segment are specified as -path length from the beginning of the path. - -``--start=LENGTH`` - - The distance from the beginning of the path where the segment begins. The - default values is 0. - -``--end=LENGTH`` - - The distance from the beginning of the path where the segment ends. The - default value is the length of path. - Showing ^^^^^^^ @@ -75,7 +57,7 @@ of the path is filled. ``--fg-color=COLOR`` - The color that is used to fill the interior of the path. + The color that is used to fill the interior of the path or stroke the path. If not specified, black is used. ``--bg-color=COLOR`` @@ -83,6 +65,45 @@ of the path is filled. The color that is used to render the background behind the path. If not specified, white is used. +``--stroke`` + + Stroke the path instead of filling it. + +``--line-width=VALUE`` + + The line width to use for the stroke. ``VALUE`` must be a positive number. + The default line width is 1. + +``--line-cap=VALUE`` + + The cap style to use at line ends. The possible values are ``butt``, ``round`` + or ``square``. See the SVG specification for details on these styles. + The default cap style is ``butt``. + +``--line-join=VALUE`` + + The join style to use at line joins. The possible values are ``miter``, + ``miter-clip``, ``round``, ``bevel`` or ``arcs``. See the SVG specification + for details on these styles. + The default join style is ``miter``. + +``--miter-limit=VALUE`` + + The limit at which to clip miters at line joins. The default value is 4. + +``--dashes=VALUE`` + + The dash pattern to use for this stroke. A dash pattern is specified by + a comma-separated list of alternating non-negative numbers. Each number + provides the length of alternate "on" and "off" portions of the stroke. + If the dash pattern is empty, dashing is disabled, which is the default. + See the SVG specification for details on dashing. + +``--dash-offset=VALUE`` + + The offset into the dash pattern where dashing should begin. + The default value is 0. + Rendering ^^^^^^^^^ @@ -96,7 +117,7 @@ The interior of the path is filled. ``--fg-color=COLOR`` - The color that is used to fill the interior of the path. + The color that is used to fill the interior of the path or stroke the path. If not specified, black is used. ``--bg-color=COLOR`` @@ -109,11 +130,50 @@ The interior of the path is filled. The file to save the PNG image to. If not specified, "path.png" is used. +``--stroke`` + + Stroke the path instead of filling it. + +``--line-width=VALUE`` + + The line width to use for the stroke. ``VALUE`` must be a positive number. + The default line width is 1. + +``--line-cap=VALUE`` + + The cap style to use at line ends. The possible values are ``butt``, ``round`` + or ``square``. See the SVG specification for details on these styles. + The default cap style is ``butt``. + +``--line-join=VALUE`` + + The join style to use at line joins. The possible values are ``miter``, + ``miter-clip``, ``round``, ``bevel`` or ``arcs``. See the SVG specification + for details on these styles. + The default join style is ``miter``. + +``--miter-limit=VALUE`` + + The limit at which to clip miters at line joins. The default value is 4. + +``--dashes=VALUE`` + + The dash pattern to use for this stroke. A dash pattern is specified by + a comma-separated list of alternating non-negative numbers. Each number + provides the length of alternate "on" and "off" portions of the stroke. + If the dash pattern is empty, dashing is disabled, which is the default. + See the SVG specification for details on dashing. + +``--dash-offset=VALUE`` + + The offset into the dash pattern where dashing should begin. + The default value is 0. + Info ^^^^ The ``info`` command shows various information about the given path, -such as its bounding box and and its length. +such as its bounding box. REFERENCES ----------