code / tomo

   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.expand_home 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Path.expand_home \- expand ~ to $HOME
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.expand_home\ :\ func(path:\ Path\ ->\ Path)
  13 .fi
  14 .SH DESCRIPTION
  15 For home-based paths (those starting with `~`), expand the path to replace the tilde with and absolute path to the user's `$HOME` directory.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 path	Path	The path to expand. 
  26 .TE
  27 .SH RETURN
  28 If the path does not start with a `~`, then return it unmodified. Otherwise, replace the `~` with an absolute path to the user's home directory.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 # Assume current user is 'user'
  33 assert (~/foo).expand_home() == (/home/user/foo)
  34 # No change
  35 assert (/foo).expand_home() == (/foo)
  36 .EE
  37 .SH SEE ALSO
  38 .BR Tomo-Path (3)