luadocs/content/lua.scripts.api.manual/dtutils.file/rmdir.md
Bill Ferguson b69d752221 [lua scripts] created manual from script comments
[lua scripts api] created manual from embedded library documentation

[lua api] created stub to contain lua api manual
2020-12-12 15:14:19 -05:00

30 lines
374 B
Markdown

---
title: rmdir
id: rmdir
weight: 160
draft: false
author: "people"
---
## NAME
rmdir
## SYNOPSIS
recursively remove a directory
## USAGE
```
local df = require "lib/dtutils.file"
df.rmdir(path)
```
**path** - _string_ - a directory path
## DESCRIPTION
**rmdir** allows directories to be removed recursively.
## RETURN VALUE
**path** - _string_ - a directory path