.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "XString 3pm" .TH XString 3pm "2022-10-19" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" XString \- Isolated String helpers from B .SH "VERSION" .IX Header "VERSION" version 0.005 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& #!perl \& \& use strict; \& use warnings; \& \& use Test::More; \& \& use XString; \& use B; \& \& is XString::cstring( q[a\*(Aqstring"with quotes] ), B::cstring( q[a\*(Aqstring"with quotes] ), q["a\*(Aqstring\e"with quotes"]; \& is XString::perlstring( q[a\*(Aqstring"with quotes] ), B::perlstring( q[a\*(Aqstring"with quotes] ), q["a\*(Aqstring\e"with quotes"]; \& \& done_testing; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" XString provides the B string helpers in one isolated package. Right now only cstring and perlstring are available. .SH "FUNCTIONS" .IX Header "FUNCTIONS" .SS "cstring(\s-1STR\s0)" .IX Subsection "cstring(STR)" Similar to B::cstring; Returns a double-quote-surrounded escaped version of \s-1STR\s0 which can be used as a string in C source code. .SS "perlstring(\s-1STR\s0)" .IX Subsection "perlstring(STR)" Similar to B::perlstring; Returns a double-quote-surrounded escaped version of \s-1STR\s0 which can be used as a string in Perl source code. .SH "AUTHOR" .IX Header "AUTHOR" Nicolas R .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2018 by cPanel, Inc. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.