John SJ Anderson > App-MiseEnPlace-0.14 > mise

Download:
App-MiseEnPlace-0.14.tar.gz

Annotate this POD

Website

View/Report Bugs
Source   Latest Release: App-MiseEnPlace-0.15

NAME ^

mise - manage directory and symlink creation, globally and per-project

VERSION ^

version 0.14

SYNOPSIS ^

    # in ~/.mise:
    ---
    manage:
      - proj/*
      - etc
    create:
      directories:
        - bin
        - doc
        - etc
        - lib
        - proj
        - src
        - var/tmp
      links:
        - var/tmp: tmp


    # in ~/proj/my-project/.mise
    ---
    create:
      links:
        bin/script: BIN
        DIR: ~/my-project

    # then run
    mise -v

    # output
    '/home/user/bin' exists
    '/home/user/doc' exists
    '/home/user/etc' exists
    '/home/user/lib' exists
    '/home/user/proj' exists
    Created '/home/user/src'
    '/home/user/var/tmp' exists
    Link from '/home/user/var/tmp' to '/home/user/tmp' exists
    Created link from /home/user/proj/my-project/bin/script to /home/user/bin/script
    Created link from /home/user/proj/my-project to /home/user/my-project

DESCRIPTION ^

mise is a simple script that allows you to manage directory and symlink creation based on a global config as well as per-project configs.

OPTIONS ^

The config file in the SYNOPSIS illustrates most of the available options.

bindir

The directory to be used for the expansion of the keyword 'BIN' when creating symlinks. (See below.) Defaults to $ENV{HOME}/bin

manage

This is a list of directories in which to search for per-project config files. Directories that don't start with a '/' are assumed to be relative to $ENV{HOME} (i.e., 'foo' will be expanded to "$ENV{HOME}/foo"). Each line will be globbed, so standard shell wildcards can be used.

This option is only valid in the "top-level" ~/.mise config file; it will have to effect if placed in a per-project config.

create/directories

This is a list of directories to create. Directories that don't start with a '/' are assumed to be relative to the directory containing the .mise file. (I.e., foo in a .mise file located in $ENV{HOME}/my/proj/ will be expanded to $ENV{HOME}/my/proj/foo)

create/links

This is a list of symlinks to create, expressed as a series of source => target pairs. Both the source and target will be expanded relative to the directory containing the .mise file, as explained above for create/directories. Additionally, if the target ends in a '/', the basename of the source value will be appended (in much the same way the ln -s works.)

Finally, there are a few keywords that can be used when creating links. If the target consists solely of the keyword 'BIN', the link will be created in the directory in the 'bindir' configuration variable, again using the basename of the source. If the source consists solely of the keyword 'DIR', the link source will be the directory containing the .mise file in question.

FLAGS ^

--config/-C FILE

Use a different config file

--remove-bin-links/-R

Makes mise remove any sylinks from the bindir after doing directory creation and before doing symlink creation.

--verbose/-v

Makes mise be very noisy about exactly what is going on.

--version/-V

Displays the version number and exits

AUTHOR ^

John SJ Anderson <genehack@genehack.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2010 by John SJ Anderson.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: