package fileutils

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

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (7)

Authors

  1. S
    Sylvain Le Gall

Maintainers

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

Sources

fileutils-0.6.4.tbz
sha256=7a7bb6bc6a36b6ebdac2b4e46a9e9b10d366c5a2d4417a5f1d68a1fbba0a445f
sha512=7053f8d92655d5631f1ec61ab7f9e3f6e3afedbe435038858dd9a026b9c769c6182afaa436491a398e7c4513b384a609e016718e030855996b2d9d54b461bd19

Description

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

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

It also provides a module to manipulate abstract filenames:

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

Published: 31 Oct 2022

README

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

OCaml-CI Build Status

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. seq
  3. stdlib-shims
  4. base-unix
  5. ocaml >= "4.03"

Dev Dependencies (1)

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

Conflicts

None