code / tomo

   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.resolved 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Path.resolved \- resolve a path
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.resolved\ :\ func(path:\ Path,\ relative_to\ =\ (./)\ ->\ Path)
  13 .fi
  14 .SH DESCRIPTION
  15 Resolves the absolute path of the given path relative to a base path. By default, the base path is the current directory.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 path	Path	The path to resolve. 	-
  26 relative_to		The base path for resolution. 	(./)
  27 .TE
  28 .SH RETURN
  29 The resolved absolute path.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert (~/foo).resolved() == (/home/user/foo)
  34 assert (./path/to/file.txt).resolved(relative_to=(/foo)) == (/foo/path/to/file.txt)
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Path (3)