luadocs/content/lua.scripts.api.manual/dtutils.file/file_copy.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

32 lines
532 B
Markdown

---
title: file_copy
id: file_copy
weight: 70
draft: false
author: "people"
---
## NAME
file_copy
## SYNOPSIS
copy a file to another name/location
## USAGE
```
local df = require "lib/dtutils.file"
local result = df.file_copy(fromFile, toFile)
```
**fromFile** - _string_ - name of file to copy from
**toFile** - _string_ - name of file to copy to
## DESCRIPTION
copy a file using a succession of methods from operating system
to a pure lua solution
## RETURN VALUE
**result** - _boolean_ - nil on error, true on success