xref: /freebsd/share/man/man9/devctl_safe_quote_sb.9 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
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.Dd September 22, 2020
25.Dt DEVCTL_SAFE_QUOTE_SB 9
26.Os
27.Sh NAME
28.Nm devctl_safe_quote_sb
29.Nd Insert a string, properly quoted, into a sbuf
30.Sh SYNOPSIS
31.In sys/devctl.h
32.In sys/sbuf.h
33.Ft void
34.Fn devctl_safe_quote_sb "struct sbuf *sb" "const char *src"
35.Sh DESCRIPTION
36Copy the string from
37.Va src
38into
39.Va sb .
40All backslash characters are doubled.
41All double quote characters
42.Sq \&"
43are also preceded by a backslash.
44All other characters are copied without modification.
45The
46.Xr devctl 4
47protocol requires quoted string to be quoted thus.
48This routine centralizes this knowledge.
49.Sh SEE ALSO
50.Xr devd 8
51.Sh AUTHORS
52This manual page was written by
53.An M. Warner Losh
54