aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Path.group.3
blob: 887165a91a19c3447324bd134bf70a4baf2135c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Path.group 3 2025-04-27 "Tomo man-pages"
.SH NAME
Path.group \- get the owning group
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.group\ :\ func(path:\ Path,\ follow_symlinks:\ Bool\ =\ yes\ ->\ Text?)
.fi
.SH DESCRIPTION
Get the owning group of a file or directory.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
path	Path	The path whose owning group to get. 	-
follow_symlinks	Bool	Whether to follow symbolic links. 	yes
.TE
.SH RETURN
The name of the group which owns the file or directory, or `none` if the path does not exist.

.SH EXAMPLES
.EX
>> (/bin).group()
= "root"
>> (/non/existent/file).group()
= none
.EE