xref: /freebsd/share/man/man9/devctl_safe_quote_sb.9 (revision a3d9bf49b57923118c339642594246ef73872ee8)
1.\"
2.\" Copyright (c) 2020 M Warner Losh
3.\"
4.\" This program is free software.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd September 22, 2020
29.Dt DEVCTL_SAFE_QUOTE_SB 9
30.Os
31.Sh NAME
32.Nm devctl_safe_quote_sb
33.Nd Insert a string, properly quoted, into a sbuf
34.Sh SYNOPSIS
35.In sys/devctl.h
36.In sys/sbuf.h
37.Ft void
38.Fn devctl_safe_quote_sb "struct sbuf *sb" "const char *src"
39.Sh DESCRIPTION
40Copy the string from
41.Vn src
42into
43.Vn sb .
44All backslash characters are doubled.
45All double quote characters
46.Sq "
47are also preceded by a backslash.
48All other characters are copied without modification.
49The
50.Xr devctl 4
51protocol requires quoted string to be quoted thus.
52This routine centralizes this knowledge.
53.Sh SEE ALSO
54.Xr devd 8
55.Sh AUTHORS
56This manual page was written by
57.An M. Warner Losh
58