home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / vtcl / doc / Concat.3 < prev    next >
Encoding:
Text File  |  1995-07-10  |  2.8 KB  |  72 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/Concat.3,v 1.6 93/04/01 09:25:23 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. '\"----------------------------------------------------------------------------
  24. '\"    @(#) Concat.3 26.1 93/10/22 SCOINC
  25. '\"
  26. '\"     Copyright (C) The Santa Cruz Operation, 1992-1993.
  27. '\"     This Module contains Proprietary Information of
  28. '\"    The Santa Cruz Operation, and should be treated as Confidential.
  29. '\"----------------------------------------------------------------------------
  30. .so ../man.macros
  31. .HS Tcl_Concat tclc
  32. .BS
  33. .SH NAME
  34. Tcl_Concat \- concatenate a collection of strings
  35. .SH SYNOPSIS
  36. .nf
  37. \fB#include <tcl.h>\fR
  38. .sp
  39. char *
  40. \fBTcl_Concat\fR(\fIargc, argv\fR)
  41. .SH ARGUMENTS
  42. .AP int argc in
  43. Number of strings.
  44. .AP char *argv[] in
  45. Array of strings to concatenate.  Must have \fIargc\fR entries.
  46. .BE
  47.  
  48. .SH DESCRIPTION
  49. .PP
  50. \fBTcl_Concat\fR is a utility procedure used by several of the
  51. Tcl commands.  Given a collection of strings, it concatenates
  52. them together into a single string, with the original strings
  53. separated by spaces.  This procedure behaves differently than
  54. \fBTcl_Merge\fR, in that the arguments are simply concatenated:
  55. no effort is made to ensure proper list structure.
  56. However, in most common usage the arguments will all be proper
  57. lists themselves;  if this is true, then the result will also have
  58. proper list structure.
  59. .PP
  60. \fBTcl_Concat\fR eliminates leading and trailing white space as it
  61. copies strings from \fBargv\fR to the result.  If an element of
  62. \fBargv\fR consists of nothing but white space, then that string
  63. is ignored entirely.  This white-space removal was added to make
  64. the output of the \fBconcat\fR command cleaner-looking.
  65. .PP
  66. The result string is dynamically allocated
  67. using \fBmalloc()\fR;  the caller must eventually release the space
  68. by calling \fBfree()\fR.
  69.  
  70. .SH KEYWORDS
  71. concatenate, strings
  72.