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