Return to gnutrition.1 CVS log

Up to [GNUtrition Sources] / gnutrition

Annotation of gnutrition/gnutrition.1, revision 1.1

1.1     ! asm         1: .TH GNUTRITION 1 "September 2026" "GNUtrition 0.1" "User Commands"
        !             2: .SH NAME
        !             3: GNUtrition \- nutrition tracking with USDA food data
        !             4: .SH SYNOPSIS
        !             5: .B gnutrition
        !             6: .RI [ OPTION ]...
        !             7: .SH DESCRIPTION
        !             8: GNUtrition is a nutrition tracker that uses USDA food data stored in a
        !             9: local SQLite database. With no options, it starts an interactive ncurses
        !            10: interface. Command-line options allow searching foods, showing nutrient
        !            11: information, and logging daily intake.
        !            12: .SH OPTIONS
        !            13: .TP
        !            14: .BR \\-search =\, QUERY "," \-s " " QUERY
        !            15: Search for foods matching QUERY.
        !            16: .TP
        !            17: .BR \\-info =\, CODE "," \-i " " CODE
        !            18: Show nutrient information for the specified food code.
        !            19: .TP
        !            20: .BR \\-log =\, CODE "," \-l " " CODE
        !            21: Log the specified food code for the selected date.
        !            22: .TP
        !            23: .BR \\-quantity =\, NUM "," \-n " " NUM
        !            24: Number of servings to log (default: 1.0). Used with
        !            25: .BR \-l .
        !            26: .TP
        !            27: .BR \\-budget "," \-b
        !            28: Show today's food-group budget summary.
        !            29: .TP
        !            30: .BR \\-calories =\, KCAL "," \-c " " KCAL
        !            31: Set the daily calorie target (default: 2000).
        !            32: .TP
        !            33: .BR \\-age =\, YEARS "," \-a " " YEARS
        !            34: Provide age in years for calorie estimation.
        !            35: .TP
        !            36: .BR \\-height =\, CM "," \-H " " CM
        !            37: Provide height in centimeters for calorie estimation.
        !            38: .TP
        !            39: .BR \\-weight =\, KG "," \-w " " KG
        !            40: Provide weight in kilograms for calorie estimation.
        !            41: .TP
        !            42: .BR \\-activity =\, LEVEL "," \-A " " LEVEL
        !            43: Set activity level: sedentary, light, moderate, very-active, or extra-active.
        !            44: .TP
        !            45: .BR \\-date =\, DATE "," \-d " " DATE
        !            46: Set the log/budget date (default: today).
        !            47: .TP
        !            48: .BR \\-db =\, PATH "," \-D " " PATH
        !            49: Set the path to the USDA food database (default: food.db).
        !            50: .TP
        !            51: .BR \\-profile-db =\, PATH "," \-P " " PATH
        !            52: Set the path to the profile/log database.
        !            53: .TP
        !            54: .BR \\-help "," \-h
        !            55: Display help and exit.
        !            56: .TP
        !            57: .BR \\-version "," \-V
        !            58: Output version information and exit.
        !            59: .SH FILES
        !            60: .TP
        !            61: .I food.db
        !            62: USDA food database built by gnutrition-updatedb.
        !            63: .TP
        !            64: .I $XDG_DATA_HOME/gnutrition/log.db
        !            65: Per-user profile and log database.
        !            66: .SH EXAMPLES
        !            67: .TP
        !            68: Search for foods containing "oat":
        !            69: .B gnutrition \-\-search="oat"
        !            70: .TP
        !            71: Show nutrient details for food code 123456:
        !            72: .B gnutrition \-\-info=123456
        !            73: .TP
        !            74: Log a food for a specific date:
        !            75: .B gnutrition \-\-log=123456 \-\-date=01/15/2026
        !            76: .TP
        !            77: Log 2.5 servings of a food:
        !            78: .B gnutrition \-\-log=123456 \-\-quantity=2.5
        !            79: .SH INTERACTIVE MODE
        !            80: When started with no command-line options, GNUtrition opens an ncurses
        !            81: interface. The main screen shows the daily food-group budget. Press:
        !            82: .TP
        !            83: .B s
        !            84: Search for foods. Use Up/Down to select a result and Enter to view its
        !            85: nutrient details. From the detail screen, press Tab to edit servings and
        !            86: date, then
        !            87: .B l
        !            88: to log the food.
        !            89: .TP
        !            90: .B l
        !            91: View the food log. Use Left/Right arrows to navigate between dates that
        !            92: have logged entries.
        !            93: .TP
        !            94: .B p
        !            95: Edit your profile (age, height, weight, activity level).
        !            96: .TP
        !            97: .B q
        !            98: Quit.
        !            99: .SH REPORTING BUGS
        !           100: Report bugs to bug-gnutrition@gnu.org.
        !           101: .SH COPYRIGHT
        !           102: Copyright \(co 2026 Free Software Foundation, Inc.
        !           103: License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
        !           104: This is free software: you are free to change and redistribute it.
        !           105: There is NO WARRANTY, to the extent permitted by law.
        !           106: .SH SEE ALSO
        !           107: .BR sqlite3 (1)