package fileutils

  1. Overview
  2. Docs
API to manipulate files (POSIX like) and filenames

Install

Dune Dependency

github.com Readme Changelog LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (10)

Authors

  1. S
    Sylvain Le Gall

Maintainers

  1. S
    Sylvain Le Gall <sylvain+ocaml@le-gall.net>

Sources

fileutils-v0.6.2.tbz
sha256=c73d94247b6aef1450853ed14677ae58e9701376475d3f29ca730472a0171e1d
sha512=104c7389832f22ec189ce6f1596144b28dcaeea7d23d5b19d369c44e54326e97fcb7b4f4c4a8d2965523e63b35b594a1351b7e630dde590871efe512fe38853c

Description

This library provides an API to perform POSIX like operations on files like:

  • mv
  • cp
  • rm
  • mkdir
  • touch
  • which...

It also providesa module to manipulate abstract filenames:

  • classification
  • make_relative: made a filename relative to another
  • make_absolute

Published: 27 Mar 2020

README

Fileutils - OCaml API to manipulate real files (POSIX like) and filenames

Features of the project:

  • pure OCaml

  • file functions inspired from GNU fileutils (aiming to be POSIX compatible)

    • cp: copy files and directories

    • mv: rename files and directories

    • rm: remove files and directories

    • test: check file types and compare values

    • find: find files that match certain criteria

    • mkdir: create directory and its parents

    • ls: list content of a directory

    • touch: change file timestamps

    • which: locate a command

    • readlink: resolve symlink

    • du: compute disk usage

    • stat: abstract of Unix.stat

    • cmp: compare files

    • chmod: change permissions of a file

  • filename functions support Win32/Unix/MacOS and Cygwin filenames:

    • Compare: is_subdir, is_updir, compare

    • Transform: make_absolute, make_relative, reduce

    • Extension: chop_extension, check_extension

Installation

The recommended way to install fileutils is via the opam package manager:

$ opam install fileutils

Documentation

API documentation is available online.

Dependencies (5)

  1. dune >= "1.11.0"
  2. stdlib-shims
  3. base-bytes
  4. base-unix
  5. ocaml >= "4.03" & < "5.0"

Dev Dependencies (1)

  1. ounit with-test & >= "2.0.0"

Conflicts

None