summaryrefslogtreecommitdiff
path: root/xmake/scripts/action/_man.lua
blob: feb70dd928487f1728eb86b58b3c472a3ef9776c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
--!The Automatic Cross-platform Build Tool
-- 
-- XMake is free software; you can redistribute it and/or modify
-- it under the terms of the GNU Lesser General Public License as published by
-- the Free Software Foundation; either version 2.1 of the License, or
-- (at your option) any later version.
-- 
-- XMake is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-- GNU Lesser General Public License for more details.
-- 
-- You should have received a copy of the GNU Lesser General Public License
-- along with XMake; 
-- If not, see <a href="http://www.gnu.org/licenses/"> http://www.gnu.org/licenses/</a>
-- 
-- Copyright (C) 2009 - 2015, ruki All rights reserved.
--
-- @author      ruki
-- @file        _man.lua
--

-- define module: _man
local _man = _man or {}

-- load modules
local utils     = require("base/utils")
local config    = require("base/config")
local platform  = require("platform/platform")
    
-- need access to the given file?
function _man.need(name)

    -- check
    assert(name)

    -- the accessors
    local accessors = { config = true, global = true, project = true }

    -- need it?
    return accessors[name]
end

-- done 
function _man.done()

    -- TODO
    print("not implement!")
 
    -- ok
    return true
end

-- the menu
function _man.menu()

    return {
                -- xmake m
                shortname = 'm'

                -- usage
            ,   usage = "xmake man|m [options] [target]"

                -- description
            ,   description = "Create a project man."

                -- options
            ,   options = 
                {
                    {'f', "file",       "kv", "xmake.lua",  "Create a given xmake.lua file."                                }
                ,   {'P', "project",    "kv", nil,          "Create from the given project directory."
                                                          , "Search priority:"
                                                          , "    1. The Given Command Argument"
                                                          , "    2. The Envirnoment Variable: XMAKE_PROJECT_DIR"
                                                          , "    3. The Current Directory"                                  }

                ,   {}
                ,   {'v', "verbose",    "k",  nil,          "Print lots of verbose information."                            }
                ,   {nil, "version",    "k",  nil,          "Print the version number and exit."                            }
                ,   {'h', "help",       "k",  nil,          "Print this help message and exit."                             }
         
                ,   {}
                ,   {nil, "target",     "v",  "all",        "Create man for the given target"                               }   
                }
            }
end

-- return module: _man
return _man